Copy documentation from gh-pages to doc/contribute #1707
Conversation
…simulator into update_contribute_page
terhorstd
added
I: No breaking change
There was a problem hiding this comment.
Thanks a lot! Nice to see all these pages coming home ;-)
I have a lot of small suggestions that I should probably already have had when the files were added to the developer space in the first place. In addition, here are some general remarks:
- make sure Git is spelled consistently in regular text
- I prefer repository over repo, please search and replace
- I did not review the Eclipse and Xcode workflows, as I've never used those. @heplesser might be able to help.
Co-authored-by: Jochen Martin Eppler <[email protected]>
…simulator into update_contribute_page
|
@jougs Thanks for the detailed review! I have applied your suggestions and replied to your comments inline. |
|
@sarakonradi It is going to take me some time to review (and revise) the Eclipse workflow. I'd suggest to drop it from this PR and create a separate issue for adding it. I am about to recreate my Eclipse setup, so I will definitely update the instructions. Concerning XCode, maybe @tammoippen could chip in? |
|
Just for the record: I'd be totally fine with removing the two IDE related pages for now. |
@heplesser Sounds good! I have created a separate issue for the Eclipse workflow and undone the review request here. |
|
@sarakonradi: many thanks! As this is "only" concerning documentation and really just a move of existing pages, I think we can do with a single review here. I'm thus merging. |
This PR copies content from the
gh-pagesbranch intodoc/contribute. It addresses the checklist items in #1659 related to the contributing guide.More specifically, it
NEST_Contributor_Agreement.pdftodoc/contributedoc/contribute/index.rstI did not remove too much from the Git workflow (yet), due to its references to NEST throughout. Please feel free to suggest which sections we can remove with clear conscience!