Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define contribution process #71

Merged
merged 7 commits into from
Sep 29, 2021
Merged

Define contribution process #71

merged 7 commits into from
Sep 29, 2021

Conversation

rabernat
Copy link
Contributor

@rabernat rabernat commented Feb 2, 2021

As noted by @ciaranevans in pangeo-forge/roadmap#9, our docs on contributing a recipe are now obsolete. This PR gets started on updating that page. Before we can really write that, we need to answer a few questions.

  • What is the expected structure of a user-contributed recipe? What files does it have to contain? What conventions should they follow?
  • Pangeo Forge can be used in a standalone way, separate from the whole cloud infrastructure; you can write and execute your recipe alone and never "contribute" it to the database of recipes. How do we discuss / distinguish this situation in the documentation?

@cisaacstern
Copy link
Member

cisaacstern commented Sep 14, 2021

@norlandrhagen, at yesterday's Pangeo Forge Coordination Meeting you mentioned that you and @jhamman may have some bandwidth to contribute to this PR. If that ends up being the case, just wanted to point you to a few resources, to avoid duplication of efforts.

First, I've just added https://github.com/pangeo-forge/flow-charts which provides as a place to collaborate on the graphical portion of this. The charts there are written in GraphViz (which is actually surprisingly great!) but if you don't want to wade into that world, feel free to open PRs against that repo with images (hand drawings, Google Slides, etc.), and I can translate them into GraphViz. (This could be for edits to existing charts, or for requesting new ones be added.)

Second, just a reminder that we previously chatted about some of the programmatic aspects of local recipe testing, here: pangeo-forge/staged-recipes#68 (comment)

Finally, the actual changes in the text of this PR probably needs to be merged with upstream/master before further work happens, as I believe the docs have been restructured since the last work happened on this.

Let me know if there's anything else I can help out with.

@norlandrhagen
Copy link
Contributor

Hey there @cisaacstern, I have a draft for some additions to docs/contributions.md. Do you want me to wait until this branch has been rebased with master before opening a PR, or what is the best way to add the edits?

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@cisaacstern
Copy link
Member

cisaacstern commented Sep 17, 2021

I just merged rebased this branch (redo-contributing). In doing so, I moved the content of what was previously docs/contribute.md into docs/intro_tutorial.md.

You can now add proposed changes to docs/intro_tutorial.md in your fork and open a PR against pangeo-forge:redo-contributing. Please let me know if I can provide any further assistance or clarification.

@cisaacstern
Copy link
Member

@norlandrhagen, this is now good to go as described in #71 (comment). The brief blip (about which you'll likely have received a notification from me) was that I needed to, as you'd correctly pointed out to begin with 😄 , rebase this branch, not merge it.

Looking forward to your contributions.

@norlandrhagen
Copy link
Contributor

Awesome thanks! I'll add what I have so far. There are definitely a lot of sections where I could use some input/feedback.

@rabernat
Copy link
Contributor Author

It looks like we can now close this, since it will be superseded by #206?

@cisaacstern
Copy link
Member

It looks like we can now close this, since it will be superseded by #206?

Actually no, because #206 is a PR to this PR.

@rabernat rabernat marked this pull request as ready for review September 29, 2021 16:14
@rabernat
Copy link
Contributor Author

Merging so we can get something up on this page. We can iterate further via future PRs.

@rabernat rabernat merged commit 244fe1d into master Sep 29, 2021
@andersy005 andersy005 deleted the redo-contributing branch October 21, 2022 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design question A question of the design of Pangeo Forge documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants