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

Improve getting started docs #4764

Merged
merged 17 commits into from Mar 20, 2024
Merged

Improve getting started docs #4764

merged 17 commits into from Mar 20, 2024

Conversation

justinegeffen
Copy link
Collaborator

Minor edits to the NF GS section, with some new section ideas.

Copy link

netlify bot commented Feb 21, 2024

Deploy Preview for nextflow-docs-staging ready!

Name Link
🔨 Latest commit b6eb3a1
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-docs-staging/deploys/65fb00aca5920000084b3e29
😎 Deploy Preview https://deploy-preview-4764--nextflow-docs-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@bentsherman bentsherman changed the title NF getting started editing Update Getting Started docs Feb 21, 2024
@bentsherman bentsherman self-requested a review February 21, 2024 16:29
Copy link
Member

@bentsherman bentsherman left a 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

@bentsherman bentsherman changed the title Update Getting Started docs Update installation docs Feb 23, 2024
@bentsherman
Copy link
Member

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.

justinegeffen and others added 5 commits February 26, 2024 18:45
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>
justinegeffen and others added 3 commits February 26, 2024 22:10
Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
@justinegeffen
Copy link
Collaborator Author

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.

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>
@bentsherman bentsherman changed the title Update installation docs Improve getting started docs Feb 28, 2024
@bentsherman
Copy link
Member

@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

  • Overview
  • Installation
  • Your first script

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>
@justinegeffen
Copy link
Collaborator Author

@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?

docs/getstarted.md Outdated Show resolved Hide resolved
docs/getstarted.md Outdated Show resolved Hide resolved
@pditommaso
Copy link
Member

Also the Get started is too long. As a developer I want to the most important information to begin. Therefore

  • Requirements
  • Install
  • Updates
  • More information e.g. "We also recommend taking a look at these pages once you’ve installed Nextflow", etc

@bentsherman
Copy link
Member

@justinegeffen yes exactly, I will restructure the pages but with your rewrites

@bentsherman
Copy link
Member

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.

@evanfloden
Copy link
Member

@justinegeffen what is happening with this PR? Putting the structure aside, the content should be updated.

@justinegeffen
Copy link
Collaborator Author

@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.

@bentsherman
Copy link
Member

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

docs/install.md Outdated Show resolved Hide resolved
docs/install.md Outdated Show resolved Hide resolved
@justinegeffen
Copy link
Collaborator Author

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.

@bentsherman
Copy link
Member

No need, I have already done it

@justinegeffen
Copy link
Collaborator Author

Thanks Ben! Ok well I'm happy to merge if you are!

docs/install.md Outdated Show resolved Hide resolved
bentsherman and others added 2 commits March 20, 2024 10:25
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>
@pditommaso pditommaso merged commit b59111b into master Mar 20, 2024
21 of 22 checks passed
@pditommaso pditommaso deleted the justinegeffen-patch-1 branch March 20, 2024 16:52
nschan pushed a commit to nschan/nextflow that referenced this pull request Apr 3, 2024
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>
nschan pushed a commit to nschan/nextflow that referenced this pull request Apr 3, 2024
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants