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

Template: add option to exclude documentation from pipeline template #3130

Merged
merged 3 commits into from
Aug 26, 2024

Conversation

mirpedrol
Copy link
Member

Part of #2340 and #2342

@mirpedrol mirpedrol requested a review from mashehu August 22, 2024 07:47
Copy link
Contributor

@mashehu mashehu left a comment

Choose a reason for hiding this comment

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

hmm, shouldn't this just be nf-core because the main link in the readme is to the nf-core website?

@mirpedrol
Copy link
Member Author

The links in the readme are actually only nf-core (see here). But the documentation files could be added for non-nf-core pipelines too, no?

@mirpedrol mirpedrol requested a review from mashehu August 26, 2024 11:45
@mashehu
Copy link
Contributor

mashehu commented Aug 26, 2024

imo readme should always be there, because that is git-best-practices. the other two files should be optional

@mirpedrol
Copy link
Member Author

The pipeline readme is always there 🙂 here we are only removing the readme inside docs

nf_core/pipelines/create/templatefeatures.yml Outdated Show resolved Hide resolved
nf_core/pipelines/create/templatefeatures.yml Outdated Show resolved Hide resolved
nf_core/pipelines/create/templatefeatures.yml Outdated Show resolved Hide resolved
@mashehu
Copy link
Contributor

mashehu commented Aug 26, 2024

ah, was confused by the description. fixed that now

@mirpedrol
Copy link
Member Author

thanks!

@mirpedrol mirpedrol force-pushed the template-customisation-documentation branch from fa8ee24 to bcbed05 Compare August 26, 2024 13:55
@mirpedrol mirpedrol merged commit 769c6fc into nf-core:dev Aug 26, 2024
79 checks passed
@mirpedrol mirpedrol deleted the template-customisation-documentation branch August 26, 2024 14:11
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