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

Strip params docs #700

Merged
merged 8 commits into from
Jul 30, 2020
Merged

Strip params docs #700

merged 8 commits into from
Jul 30, 2020

Conversation

ewels
Copy link
Member

@ewels ewels commented Jul 29, 2020

Start stripping out parameter docs from template usage.md. See #647

@ewels ewels requested a review from mashehu July 29, 2020 14:39
@codecov

This comment has been minimized.

@ewels ewels force-pushed the strip-params-docs branch from a0a12e8 to 4368b2f Compare July 30, 2020 09:21
@ewels
Copy link
Member Author

ewels commented Jul 30, 2020

(Rebased with upstream changes)

ewels added 2 commits July 30, 2020 12:55
People can read about these on nf-core/configs I think, as that's where the config profile is kept.
@ewels ewels marked this pull request as ready for review July 30, 2020 10:58

## Reference genomes

The pipeline config files come bundled with paths to the illumina iGenomes reference index files. If running with docker or AWS, the configuration is set up to use the [AWS-iGenomes](https://ewels.github.io/AWS-iGenomes/) resource.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the pipeline schema template doesn't explain what iGenomes is. I liked this and the longer explanation in line 78+, otherwise it seems rather cryptic to newcomers.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a link to the website docs in the schema in cb72dda - is this ok?

We're probably dropping all if iGenomes soon anyway, so I'm not too fussed.

Copy link
Member

@ggabernet ggabernet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

ewels and others added 2 commits July 30, 2020 14:06
@ewels ewels merged commit 9bbced4 into nf-core:dev Jul 30, 2020
@ewels ewels deleted the strip-params-docs branch July 30, 2020 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants