Skip to content

Add a list of external PyGMT resources#1210

Merged
seisman merged 7 commits intomasterfrom
external-resources
Apr 20, 2021
Merged

Add a list of external PyGMT resources#1210
seisman merged 7 commits intomasterfrom
external-resources

Conversation

@seisman
Copy link
Member

@seisman seisman commented Apr 14, 2021

Description of proposed changes

Fixes #1059

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@seisman seisman mentioned this pull request Apr 14, 2021
Closed
@seisman seisman added the documentation Improvements or additions to documentation label Apr 14, 2021
@seisman seisman added this to the 0.4.0 milestone Apr 14, 2021
@seisman seisman force-pushed the external-resources branch from 367cc93 to 44ee95a Compare April 14, 2021 06:10
@maxrjones
Copy link
Member

maxrjones commented Apr 14, 2021

Thanks for submitting this PR - the resources are great!

I would prefer that these resources go under a different section than 'getting started'. One option would be to have a new "Examples" section that could include the "Gallery" and "External examples". I think that the external tutorials could be included in that section for now, but long term could go into the redesigned tutorial sidebar (#1191).

Also, I prefer "External examples" or something else over "User Contributed Resources" to make it more clear PyGMT is not trying to take ownership of these resources and is just providing links. I think this could make people who aren't PyGMT developers more likely to include links to their PyGMT projects in the page.

@michaelgrund
Copy link
Member

michaelgrund commented Apr 14, 2021

Thanks for submitting this PR - the resources are great!

I would prefer that these resources go under a different section than 'getting started'. One option would be to have a new "Examples" section that could include the "Gallery" and "External examples". I think that the external tutorials could be included in that section for now, but long term could go into the redesigned tutorial sidebar (#1191).

Also, I prefer "External examples" or something else over "User Contributed Resources" to make it more clear PyGMT is not trying to take ownership of these resources and is just providing links. I think this could make people who aren't PyGMT developers more likely to include links to their PyGMT projects in the page.

I agree with @meghanrjones , would also use something like "External examples".

@seisman
Copy link
Member Author

seisman commented Apr 14, 2021

I would prefer that these resources go under a different section than 'getting started'. One option would be to have a new "Examples" section that could include the "Gallery" and "External examples". I think that the external tutorials could be included in that section for now, but long term could go into the redesigned tutorial sidebar (#1191).

Also, I prefer "External examples" or something else over "User Contributed Resources" to make it more clear PyGMT is not trying to take ownership of these resources and is just providing links. I think this could make people who aren't PyGMT developers more likely to include links to their PyGMT projects in the page.

Good suggestion. I renamed the page to "External Resources" and moved it to the "Examples" section.

maxrjones
maxrjones reviewed Apr 14, 2021
View reviewed changes
Copy link
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! I just have one small comment about the instructions for adding an example.

@seisman
Improve the instruction
2e23e3b 
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
@seisman seisman marked this pull request as ready for review April 14, 2021 22:01
maxrjones
maxrjones approved these changes Apr 14, 2021
View reviewed changes
Copy link
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

maxrjones
maxrjones reviewed Apr 14, 2021
View reviewed changes
@core-man
Copy link
Member

core-man commented Apr 15, 2021

Looks great~

@seisman seisman changed the title Add a list of user contributed resources Add a list of external PyGMT resources Apr 15, 2021
michaelgrund
michaelgrund approved these changes Apr 15, 2021
View reviewed changes
Copy link
Member

@michaelgrund michaelgrund left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

seisman
seisman commented Apr 15, 2021
View reviewed changes
@seisman
Copy link
Member Author

seisman commented Apr 15, 2021

Ping @liamtoney and @weiji14 as their contributions are listed.

@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Apr 15, 2021
weiji14
weiji14 reviewed Apr 18, 2021
View reviewed changes
@seisman @weiji14
Apply suggestions from code review
7220fd4 
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Apr 20, 2021
@seisman seisman merged commit 81ed10b into master Apr 20, 2021
@seisman seisman deleted the external-resources branch April 20, 2021 03:50
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
@seisman @weiji14
Add a list of external PyGMT resources (GenericMappingTools#1210)
5c00269 
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@maxrjones maxrjones maxrjones approved these changes

@core-man core-man core-man approved these changes

@michaelgrund michaelgrund michaelgrund approved these changes

@weiji14 weiji14 weiji14 approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

0.4.0

Development

Successfully merging this pull request may close these issues.

Curate a list of PyGMT community contributions

5 participants

@seisman @maxrjones @michaelgrund @core-man @weiji14