Incorporate README content into Nextflow docs #4263
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Ben Sherman <[email protected]>
✅ Deploy Preview for nextflow-docs-staging canceled.
|
ewels
reviewed
Sep 4, 2023
There was a problem hiding this comment.
Very nice! Massive improvement on the readme especially. I'm not sure that I have ever actually looked through the current readme before 😆
Is there some way that we could also publish CONTRIBUTING.md in the main Nextflow docs website? (without duplicating the file contents). I guess we could do it as a pre-build step? It would be great to have everything in there.
Related - my preference would be to do away with plugins/README.md completely. Just have all documentation in the actual docs.
Also, we should really do a dark-mode version of the logo in the readme. It's just "next" when using GitHub in dark mode currently 😓
Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
Co-authored-by: Phil Ewels <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
Co-authored-by: Phil Ewels <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
Co-authored-by: Phil Ewels <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
ewels
reviewed
Sep 21, 2023
Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
ewels
reviewed
Sep 23, 2023
Co-authored-by: Phil Ewels <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
Co-authored-by: Phil Ewels <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
Co-authored-by: Phil Ewels <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
Co-authored-by: Phil Ewels <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
Co-authored-by: Phil Ewels <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
Co-authored-by: Phil Ewels <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
Co-authored-by: Phil Ewels <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
Co-authored-by: Phil Ewels <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
Co-authored-by: Phil Ewels <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
|
@pditommaso think this one is ready for you. Please see Phil's comments about the README badges and bioconda install command, I don't feel any particular way about them so I leave them to you. |
ewels
approved these changes
Sep 27, 2023
Co-authored-by: Marcel Ribeiro-Dantas <[email protected]> Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
pditommaso
reviewed
Oct 5, 2023
pditommaso
reviewed
Oct 5, 2023
pditommaso
reviewed
Oct 5, 2023
Signed-off-by: Paolo Di Tommaso <[email protected]>
pditommaso
approved these changes
Oct 5, 2023
abhi18av
pushed a commit
to abhi18av/nextflow
that referenced
this pull request
Oct 28, 2023
Signed-off-by: Ben Sherman <[email protected]> Signed-off-by: Paolo Di Tommaso <[email protected]> Co-authored-by: Phil Ewels <[email protected]> Co-authored-by: Marcel Ribeiro-Dantas <[email protected]> Co-authored-by: Paolo Di Tommaso <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Close #4256
As for the original issue, I think it is enough to add the user-facing plugin environment variables to the Nextflow docs. But most of the documentation in
plugins/README.mdis specific to the core plugins.More broadly, I tried to cat the main README down to size, removing information that is already covered by the docs, and moving the main motivation paragraph to the docs main page which currently only shows the table of contents.
I think the CONTRIBUTING.md and the plugins README.md could both be incorporated into the developer docs #4085 once that PR is merged.