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
Improve getting started docs #4764
Conversation
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My preference is to keep the updates and stable/edge release sections where they were, but if it is a step towards future work then I'll trust your judgement
Thinking more on this, I felt it was better to leave the section order unchanged. I think we will move the installation piece to a separate "Installation" page (much clearer IMO) and develop the getting started page into a more comprehensive walkthrough, so no point in playing around with the sections here. |
Minor edits to the NF GS section, with some new section ideas. Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
0d67b80
to
fd07dbd
Compare
Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
I'm happy with that. This PR is an incremental update to the first five minutes of Nextflow and doesn't need to include a lot of restructuring. |
Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
@justinegeffen I initially wanted to hold of on reorgs, but now that I've finished my exploration in #4766, I think this PR would be a good place to change the introductory pages as I have done in that PR (preview): Introduction
Because that PR is quite large and I would rather push it in small increments where I can. Let me know if you like this structure and I will update this PR. |
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
@bentsherman, I'm happy with the structure you've proposed but the content changes on this PR would be ideal. Would you be open to merging this PR so we have the content, and then copying that content into your structure changes? |
Also the Get started is too long. As a developer I want to the most important information to begin. Therefore
|
@justinegeffen yes exactly, I will restructure the pages but with your rewrites |
I have rearranged the introduction pages to flow a bit better. I think there were some artifacts because I pushed some changes earlier and you tried to merge them. I should have waited for you to finish so I apologize. You can mark the PR as a draft to let us know that you're still working on it, otherwise I will think it's ready for review. If you do make any more changes, make sure to pull the latest commits from this PR first. |
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
@justinegeffen what is happening with this PR? Putting the structure aside, the content should be updated. |
Thanks for the ping, Evan. I'm going to close this PR as it's slipped out of alignment. We'll be starting work on a new Getting Started guide this week. |
I would be fine with merging the PR as is, even if some of it gets moved elsewhere it's still a step in the right direction |
I'm also happy to take that path! I will adjust the content as per Paolo's feedback and ping you for a review tomorrow. |
No need, I have already done it |
Thanks Ben! Ok well I'm happy to merge if you are! |
Co-authored-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com> Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com> Signed-off-by: Ben Sherman <bentshermann@gmail.com> Co-authored-by: Ben Sherman <bentshermann@gmail.com> Co-authored-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com> Signed-off-by: Niklas Schandry <niklas@bio.lmu.de>
Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com> Signed-off-by: Ben Sherman <bentshermann@gmail.com> Co-authored-by: Ben Sherman <bentshermann@gmail.com> Co-authored-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com> Signed-off-by: Niklas Schandry <niklas@bio.lmu.de>
Minor edits to the NF GS section, with some new section ideas.