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

Guideline updates #63

Merged
merged 8 commits into from
Apr 9, 2024
Merged

Guideline updates #63

merged 8 commits into from
Apr 9, 2024

Conversation

muffato
Copy link
Member

@muffato muffato commented Apr 5, 2024

Added:

  • A description of the branch model and how to deal with bugfixes
  • Instructions for adding a new pipeline.
    • Can you double-check who can add repositories to the nextflow_all and nextflow_admin teams ? I couldn't find clear documentation on GitHub
    • Also, for updating the settings via the pipeline website, I know it's something people can do on their own, but it needs the pipeline to be recognised by the website first. Should we change the instruction to "Wait a few hours until the pipeline shows up, then click "Fix data" ?

@muffato
Copy link
Member Author

muffato commented Apr 5, 2024

The docs are deployed at http://pipelines.tol-dev.sanger.ac.uk/docs

@muffato
Copy link
Member Author

muffato commented Apr 8, 2024

Just added a small paragraph about the Zenodo integration. Even if it's already mentioned in the "Release instructions", better to do it right at the beginning before anyone forgets

@muffato
Copy link
Member Author

muffato commented Apr 8, 2024

I've addressed both comments and updated the checkout on the dev VM

@@ -14,6 +14,14 @@ This is done by using the `nf-core create` command - see [the docs](https://nf-c
This tool does lots of things for you: it gives you the correct file structure and boiler plate code
and also sets up the required `git` infrastructure for you to keep your pipeline in sync in the future.

When asked _Do you want to customize which parts of the template are used ?_, answer `Y`.
Copy link
Member

Choose a reason for hiding this comment

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

Let's use small y for yes. Big N is the default answer.

@gq1
Copy link
Member

gq1 commented Apr 8, 2024

I don't have permission to add any repos to teams.

I think the current instruction to fix the repo setting is fine. The statistics page is only updated once in the morning by the cron job, and the same as the pipeline list. The developers don't really need to worry about this at the beginning, we can do this behind.

@muffato muffato merged commit fff5606 into main Apr 9, 2024
3 checks passed
@muffato muffato added documentation Improvements or additions to documentation team labels Jun 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants