From ca5554418313c167156e5c6cba3802d4a5f3e9b1 Mon Sep 17 00:00:00 2001 From: Edmund Miller Date: Mon, 17 Jun 2024 15:32:09 -0500 Subject: [PATCH 01/16] chore: Add Slack Message from @jfy133 Co-authored-by: jfy133 --- .../docs/checklists/maintainers_team_updates.mdx | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 src/content/docs/checklists/maintainers_team_updates.mdx diff --git a/src/content/docs/checklists/maintainers_team_updates.mdx b/src/content/docs/checklists/maintainers_team_updates.mdx new file mode 100644 index 0000000000..660661fefd --- /dev/null +++ b/src/content/docs/checklists/maintainers_team_updates.mdx @@ -0,0 +1,12 @@ +Ask who wants to step down +Ask for nominations in maintainers meeting, discuss and approve +Ask nominees +Once accepted, add to #team-maintainers (and remove alumni/extras) +Once accepted, make PRs and merge in: +Website > Governance page +Maintainers minutes blog announcement +Announce on #announcements +Update team lists: +Github +Slack +Add new maintainers to google calendar(s) From 8688c0c9683124c772aabbf5dbcd7cba587a6dc9 Mon Sep 17 00:00:00 2001 From: Edmund Miller Date: Mon, 17 Jun 2024 15:36:29 -0500 Subject: [PATCH 02/16] Try to use fancy checklists --- .../checklists/maintainers_team_updates.mdx | 30 +++++++++++-------- 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/src/content/docs/checklists/maintainers_team_updates.mdx b/src/content/docs/checklists/maintainers_team_updates.mdx index 660661fefd..1278370013 100644 --- a/src/content/docs/checklists/maintainers_team_updates.mdx +++ b/src/content/docs/checklists/maintainers_team_updates.mdx @@ -1,12 +1,18 @@ -Ask who wants to step down -Ask for nominations in maintainers meeting, discuss and approve -Ask nominees -Once accepted, add to #team-maintainers (and remove alumni/extras) -Once accepted, make PRs and merge in: -Website > Governance page -Maintainers minutes blog announcement -Announce on #announcements -Update team lists: -Github -Slack -Add new maintainers to google calendar(s) +--- +title: Maintainers Team Updates +subtitle: A step-by-step guide for changing of the guard +markdownPlugin: checklist +--- + +1. [ ] Ask who wants to step down +2. [ ] Ask for nominations in maintainers meeting, discuss and approve +3. [ ] Ask nominees +4. [ ] Once accepted, add to [#team-maintainers](https://nfcore.slack.com/archives/C043UU89KKQ) (and remove alumni/extras) +5. [ ] Once accepted, make PRs and merge in: + - [ ] Website > Governance page + - [ ] Maintainers minutes blog announcement +8. [ ] Announce on [#announcements](https://nfcore.slack.com/archives/CE6P95170) +9. [ ] Update team lists: + - [ ] [Github](https://github.com/orgs/nf-core/teams/maintainers) + - [ ] Slack +10. [ ] Add new maintainers to google calendar(s) From d8a07c10c663a3a0a1c1ccf6923ef1f2af148836 Mon Sep 17 00:00:00 2001 From: "James A. Fellows Yates" Date: Sat, 9 Nov 2024 11:34:12 +0100 Subject: [PATCH 03/16] Apply suggestions from code review --- src/content/docs/checklists/maintainers_team_updates.mdx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/content/docs/checklists/maintainers_team_updates.mdx b/src/content/docs/checklists/maintainers_team_updates.mdx index 1278370013..c557c18c77 100644 --- a/src/content/docs/checklists/maintainers_team_updates.mdx +++ b/src/content/docs/checklists/maintainers_team_updates.mdx @@ -3,12 +3,15 @@ title: Maintainers Team Updates subtitle: A step-by-step guide for changing of the guard markdownPlugin: checklist --- +Roughly once a year we review the maintainers team to ensure we have sufficient capacity to keep up with the community activity. + +The following steps are what the maintainers team leads need to do during the review. 1. [ ] Ask who wants to step down 2. [ ] Ask for nominations in maintainers meeting, discuss and approve 3. [ ] Ask nominees 4. [ ] Once accepted, add to [#team-maintainers](https://nfcore.slack.com/archives/C043UU89KKQ) (and remove alumni/extras) -5. [ ] Once accepted, make PRs and merge in: +5. [ ] Once accepted, make PRs to add/move to alumni members and merge in: - [ ] Website > Governance page - [ ] Maintainers minutes blog announcement 8. [ ] Announce on [#announcements](https://nfcore.slack.com/archives/CE6P95170) From 3fdfc477ce232655e45a4a0f1482d21dc3cf5aae Mon Sep 17 00:00:00 2001 From: "James A. Fellows Yates" Date: Sat, 9 Nov 2024 11:04:00 +0000 Subject: [PATCH 04/16] Restructure, add core team docs too --- .../community_governance/core_team.mdx | 49 +++++++++++++++++++ .../community_governance/maintainers_team.mdx | 33 +++++++++++++ .../checklists/maintainers_team_updates.mdx | 18 ------- 3 files changed, 82 insertions(+), 18 deletions(-) create mode 100644 src/content/docs/checklists/community_governance/core_team.mdx create mode 100644 src/content/docs/checklists/community_governance/maintainers_team.mdx delete mode 100644 src/content/docs/checklists/maintainers_team_updates.mdx diff --git a/src/content/docs/checklists/community_governance/core_team.mdx b/src/content/docs/checklists/community_governance/core_team.mdx new file mode 100644 index 0000000000..dc9a601860 --- /dev/null +++ b/src/content/docs/checklists/community_governance/core_team.mdx @@ -0,0 +1,49 @@ +--- +title: Core Checklists +subtitle: Step-by-step guides for core team tasks +markdownPlugin: checklist +--- + +## New pipeline onboarding + +This documents the steps that need to be performed when a new pipeline is accepted via #new-pipelines + +1. [ ] Core: Check proposal has received approval on #new-pipelines from either: + - at least 2 members of core team + - at least 1 member of core team and 1 member of maintainers team +2. [ ] Core: Check name follows [pipeline naming guidelines](/docs/guidelines/pipelines/workflow_name) +3. [ ] Core: Make slack channel with approved name +4. [ ] Core: Ask developer to join #pipeline-maintainers +5. [ ] Core/Dev: Make git repository with nf-core create and push to GitHub +6. [ ] Core/Dev: Transfer repository to nf-core GitHub organisation and delete repository on local machine +7. [ ] Core/Dev: Sync the nf-co.re pipelines page by manually triggering the GitHub action (website repo > actions > build json files and md-cache > Run workflow > from main) + +## Adding new community member to the GitHub organisation + +Anyone can request to join the nf-core GitHub organisation via #github-invitations. + +1. [ ] Check they have a reasonable to join (clearly not spam) +2. [ ] Invite via https://github.com/orgs/nf-core/teams +3. [ ] Make sure to do team 'contributors' https://github.com/orgs/nf-core/teams/contributors +4. [ ] Press ✅ on their message in #github-invitations + +## New core team member onboarding + +This documents the steps that need to be performed when adding a new core team member: + +1. [ ] Add to core team slack channel +2. [ ] Add to GitHub core team +3. [ ] Add as owners on the GitHub org +4. [ ] Add to @core-team @outreach-team slack teams +5. [ ] Add as admin on slack +6. [ ] Add to hackMD team as Admin +7. [ ] Add to quay.io in team owners +8. [ ] Add to Tower organisation as owner +9. [ ] Add to nf-core google calendar(s) +10. [ ] Add to core@nf-co.re forwarder +11. [ ] Add to [Zenodo community](https://zenodo.org/communities/nf-core/records?q=&l=list&p=1&s=10) as admin +12. [ ] Create personal @nf-co.re email +13. [ ] Update Website / About (get new member to check) +14. [ ] Tell new member to add nf-core apple core emoji as Status +15. [ ] Slack announcement +16. [ ] Social media announcement diff --git a/src/content/docs/checklists/community_governance/maintainers_team.mdx b/src/content/docs/checklists/community_governance/maintainers_team.mdx new file mode 100644 index 0000000000..528fae7170 --- /dev/null +++ b/src/content/docs/checklists/community_governance/maintainers_team.mdx @@ -0,0 +1,33 @@ +--- +title: Maintainers Checklists +subtitle: Step-by-step guides for maintainers team tasks +markdownPlugin: checklist +--- + +## Maintainers Team Onboarding + +Team Leads: + +1. [ ] Add member to [#team-maintainers](https://nfcore.slack.com/archives/C043UU89KKQ) +2. [ ] Add member to [Github group](https://github.com/orgs/nf-core/teams/maintainers) +3. [ ] Add member to Slack group +4. [ ] Add new maintainers to the [Maintainers team google calendar](https://calendar.google.com/calendar/u/0?cid=ZDA3MmVkOGI1NzQ0YWViOWE3ZjBkMDE4YjFjZWE1OGE5M2MwZDZlZTIyMzM1YWE5YzA0NTlmODg0YTZkMDNkZEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t) + +New Maintainer: + +1. [ ] Make a PR to nf-core website adding themselves to the [About > Governance > Maintainers section](https://nf-co.re/governance#maintainers) + +## Maintainers Team Yearly Maintenance + +:::note +Maintainers can be added at any point of the year at the nomination of the community. +Yearly maintenance is performed to ensure everything is up-to-date particularly in regards to members who step down. +::: + +1. [ ] Ask who wants to step down +2. [ ] Ask for nominations in maintainers meeting, discuss and approve +3. [ ] Invite nominees to join +4. [ ] Once accepted, nominee and team leads perform tasks [onboarding](#maintainers-team-onboarding) +5. [ ] Move members who are stepping down to alumni status on website in the [About > Governance > Maintainers section](https://nf-co.re/governance#maintainers) + +6. [ ] Announce on [#announcements](https://nfcore.slack.com/archives/CE6P95170) diff --git a/src/content/docs/checklists/maintainers_team_updates.mdx b/src/content/docs/checklists/maintainers_team_updates.mdx deleted file mode 100644 index 1278370013..0000000000 --- a/src/content/docs/checklists/maintainers_team_updates.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Maintainers Team Updates -subtitle: A step-by-step guide for changing of the guard -markdownPlugin: checklist ---- - -1. [ ] Ask who wants to step down -2. [ ] Ask for nominations in maintainers meeting, discuss and approve -3. [ ] Ask nominees -4. [ ] Once accepted, add to [#team-maintainers](https://nfcore.slack.com/archives/C043UU89KKQ) (and remove alumni/extras) -5. [ ] Once accepted, make PRs and merge in: - - [ ] Website > Governance page - - [ ] Maintainers minutes blog announcement -8. [ ] Announce on [#announcements](https://nfcore.slack.com/archives/CE6P95170) -9. [ ] Update team lists: - - [ ] [Github](https://github.com/orgs/nf-core/teams/maintainers) - - [ ] Slack -10. [ ] Add new maintainers to google calendar(s) From c04f40393a584b2b1fda4c1b8b64bb64353fd368 Mon Sep 17 00:00:00 2001 From: "James A. Fellows Yates" Date: Sat, 9 Nov 2024 11:20:28 +0000 Subject: [PATCH 05/16] Finish transfer for core-team tasks --- .../community_governance/core_team.mdx | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/src/content/docs/checklists/community_governance/core_team.mdx b/src/content/docs/checklists/community_governance/core_team.mdx index dc9a601860..f94dea12a0 100644 --- a/src/content/docs/checklists/community_governance/core_team.mdx +++ b/src/content/docs/checklists/community_governance/core_team.mdx @@ -18,6 +18,43 @@ This documents the steps that need to be performed when a new pipeline is accept 6. [ ] Core/Dev: Transfer repository to nf-core GitHub organisation and delete repository on local machine 7. [ ] Core/Dev: Sync the nf-co.re pipelines page by manually triggering the GitHub action (website repo > actions > build json files and md-cache > Run workflow > from main) +## Uploading test data to s3 bucket + +Uploading full-test AWS files for a pipeline to S3 bucket information: + +- [ ] Check Valid test data that can be uploaded: + - [ ] Small input data that maybe flaky when downloaded from other repositories + e.g. Max of 10GB for the total across all files + - [ ] Very large files that cannot be reduced or subset +- [ ] When creating the pipeline directory in the bucket, use the 'Amazon S3-managed keys (SSE-S3) option + +## Activating Zenodo archiving of a new pipeline + +Instructions for setting up Zenodo DOIs. +Anyone who is in the nf-core organization can do this! + +Before release: + +1. [ ] Sign up with Zenodo and log in +2. [ ] Make sure you have connected your github (Settings -> GitHub -> Connect Account) +3. [ ] Once connected, go back to Settings -> GitHub +4. [ ] Flip switch against all nf-core _pipeline_ repositories in the list of repositories to 'On' (including the one that you want to assign) + - Might as well do this for all (active) pipelines you see, as DOIs won't be assigned until release anyway + - Some will not activate (e.g. nf-core/exoseq) as they are archived! +5. [ ] Tell pipeline developer to make a release + +Post release: + +1. [ ] Go to Zenodo and find the repository of interest on the list repositories under Settings -> Github +2. [ ] Click through to the release's Zenodo 'record' page +3. [ ] Scroll down and look on the right-hand side of the page for the 'Communities' box, submit the record to the nf-core community +4. [ ] Scroll down and again look on the right-hand side of the page for the 'Versions' box +5. [ ] Copy the 'cite all versions by using the DOI ' DOI (_not_ the specific release!) +6. [ ] On the master branch of the pipeline's repository, edit the following files: + - **README.md**: Zenodo Badge at the top, and 'If you use this pipeline cite:' at the bottom (make sure to uncomment this section too) + - **Nextflow.config**: manifest's DOI entry + - Commit with something like 'Add Zenodo ID after first release' + ## Adding new community member to the GitHub organisation Anyone can request to join the nf-core GitHub organisation via #github-invitations. @@ -27,6 +64,25 @@ Anyone can request to join the nf-core GitHub organisation via #github-invitatio 3. [ ] Make sure to do team 'contributors' https://github.com/orgs/nf-core/teams/contributors 4. [ ] Press ✅ on their message in #github-invitations +## Updating online bingo cards + +We need to update the [bingo cards](https://nfcore-bingo.web.app/) before each hackathon to ensure they remain up-to-date. + +1. [ ] Get the outreach google account credentials +2. [ ] Log into the Firebase Dashboard: https://console.firebase.google.com/ +3. [ ] Click “Realtime Database” on the left +4. [ ] In the middle click “games” and navigate down the tree until you reach “lexicon” +5. [ ] Hover over “lexicon”, click on “+” to add entries. + - key: Number + - value: New board entry +6. To delete entries: Click on the trash bin next to the given entry. + +## Backups + +The following items should be regularly backed up by a member of core team with admin access to the relevant service: + +- HackMD: backup to Google Drive (Outreach) + ## New core team member onboarding This documents the steps that need to be performed when adding a new core team member: From bcaf5c726657275b4486f0169cf23379bcad7d28 Mon Sep 17 00:00:00 2001 From: "James A. Fellows Yates" Date: Sat, 9 Nov 2024 14:11:56 +0100 Subject: [PATCH 06/16] Apply suggestions from code review Co-authored-by: Sateesh_Peri <33637490+sateeshperi@users.noreply.github.com> --- .../community_governance/core_team.mdx | 79 +++++++++---------- 1 file changed, 39 insertions(+), 40 deletions(-) diff --git a/src/content/docs/checklists/community_governance/core_team.mdx b/src/content/docs/checklists/community_governance/core_team.mdx index f94dea12a0..0c19bded54 100644 --- a/src/content/docs/checklists/community_governance/core_team.mdx +++ b/src/content/docs/checklists/community_governance/core_team.mdx @@ -6,69 +6,68 @@ markdownPlugin: checklist ## New pipeline onboarding -This documents the steps that need to be performed when a new pipeline is accepted via #new-pipelines - -1. [ ] Core: Check proposal has received approval on #new-pipelines from either: - - at least 2 members of core team - - at least 1 member of core team and 1 member of maintainers team -2. [ ] Core: Check name follows [pipeline naming guidelines](/docs/guidelines/pipelines/workflow_name) -3. [ ] Core: Make slack channel with approved name -4. [ ] Core: Ask developer to join #pipeline-maintainers -5. [ ] Core/Dev: Make git repository with nf-core create and push to GitHub -6. [ ] Core/Dev: Transfer repository to nf-core GitHub organisation and delete repository on local machine -7. [ ] Core/Dev: Sync the nf-co.re pipelines page by manually triggering the GitHub action (website repo > actions > build json files and md-cache > Run workflow > from main) +This document outlines the steps to be performed when a new pipeline is accepted via the #new-pipelines channel + +1. [ ] Core: Check proposal has received approval in #new-pipelines from either: + - at least two members of the core team + - at least one member of the core team and one member of the maintainers team. +2. [ ] Core: Verify that the pipeline name follows the [pipeline naming guidelines](/docs/guidelines/pipelines/workflow_name). +3. [ ] Core: Create a slack channel with approved pipeline name. +4. [ ] Core: Ask the developers to join #pipeline-maintainers channel. +5. [ ] Core/Dev: Create the git repository using `nf-core create` and push it to GitHub. +6. [ ] Core/Dev: Transfer the repository to nf-core GitHub organisation and delete the repository on local the machine/user account. +7. [ ] Core/Dev: Sync the nf-co.re pipelines page by manually triggering the GitHub action (website repo -> actions -> build json files and md-cache -> Run workflow -> from main). ## Uploading test data to s3 bucket -Uploading full-test AWS files for a pipeline to S3 bucket information: +Instructions for uploading full-test AWS files for a pipeline to a S3 bucket: - [ ] Check Valid test data that can be uploaded: - - [ ] Small input data that maybe flaky when downloaded from other repositories - e.g. Max of 10GB for the total across all files - - [ ] Very large files that cannot be reduced or subset -- [ ] When creating the pipeline directory in the bucket, use the 'Amazon S3-managed keys (SSE-S3) option + - [ ] Small input data that maybe unreliable when downloaded from other repositories + (e.g., limit total file size to a maximum of 10GB across all files) + - [ ] Very large files that cannot be reduced or subsetted. +- [ ] When creating the pipeline directory in the S3 bucket, select the 'Amazon S3-managed keys (SSE-S3)` option. ## Activating Zenodo archiving of a new pipeline -Instructions for setting up Zenodo DOIs. -Anyone who is in the nf-core organization can do this! +Instructions for setting up Zenodo DOIs. +It's recommended that a core team member does these steps as it makes it easier for us to transfer to the nf-core Zenodo community. Before release: -1. [ ] Sign up with Zenodo and log in -2. [ ] Make sure you have connected your github (Settings -> GitHub -> Connect Account) +1. [ ] Sign up on Zenodo and log in. +2. [ ] Connect your Github account (Go to Settings -> GitHub -> Connect Account). 3. [ ] Once connected, go back to Settings -> GitHub -4. [ ] Flip switch against all nf-core _pipeline_ repositories in the list of repositories to 'On' (including the one that you want to assign) - - Might as well do this for all (active) pipelines you see, as DOIs won't be assigned until release anyway - - Some will not activate (e.g. nf-core/exoseq) as they are archived! -5. [ ] Tell pipeline developer to make a release +4. [ ] Enable Zenodo archiving for all nf-core pipeline repositories by toggling the switch to `On` (including the one you want to assign). + - It’s a good idea to enable this for all active pipelines, as DOIs will only be assigned upon release. + - Note: Some repositories (e.g. nf-core/exoseq) may not activate as they are archived. +5. [ ] Inform the pipeline developers to make a release. Post release: -1. [ ] Go to Zenodo and find the repository of interest on the list repositories under Settings -> Github -2. [ ] Click through to the release's Zenodo 'record' page -3. [ ] Scroll down and look on the right-hand side of the page for the 'Communities' box, submit the record to the nf-core community -4. [ ] Scroll down and again look on the right-hand side of the page for the 'Versions' box -5. [ ] Copy the 'cite all versions by using the DOI ' DOI (_not_ the specific release!) -6. [ ] On the master branch of the pipeline's repository, edit the following files: - - **README.md**: Zenodo Badge at the top, and 'If you use this pipeline cite:' at the bottom (make sure to uncomment this section too) - - **Nextflow.config**: manifest's DOI entry - - Commit with something like 'Add Zenodo ID after first release' +1. [ ] Go to Zenodo and find the relevant repository in Settings -> Github. +2. [ ] Click through to the Zenodo 'record' page for the release. +3. [ ] On the record page, scroll down and look on the right-hand side and find the `Communities` box. Submit the record to the nf-core community. +4. [ ] Scroll down and again on the right-hand side of the page for the `Versions` box, copy the DOI for 'cite all versions by using the DOI ' (_not_ the specific release DOI). +5. [ ] Update the following files on the master branch of the pipeline repository: + - **README.md**: Add the Zenodo Badge at the top and update the 'If you use this pipeline cite:' section at the bottom (make sure to uncomment this section too). + - **Nextflow.config**: Update the manifest block to include the DOI. + - Commit these changes with a message like 'Add Zenodo ID after first release'. ## Adding new community member to the GitHub organisation -Anyone can request to join the nf-core GitHub organisation via #github-invitations. +Anyone can request to join the nf-core GitHub organisation via the #github-invitations channel. -1. [ ] Check they have a reasonable to join (clearly not spam) -2. [ ] Invite via https://github.com/orgs/nf-core/teams -3. [ ] Make sure to do team 'contributors' https://github.com/orgs/nf-core/teams/contributors -4. [ ] Press ✅ on their message in #github-invitations +1. [ ] Verify the request is reasonable (i.e., clearly not spam). +2. [ ] Send an invitation via [nf-core github teams](https://github.com/orgs/nf-core/teams) +3. [ ] Add them to the [nf-core contributors team](https://github.com/orgs/nf-core/teams/contributors) +4. [ ] Respond to the request on slack by reacting with ✅ on their message in #github-invitations channel (so they get their acceptance instructions). ## Updating online bingo cards -We need to update the [bingo cards](https://nfcore-bingo.web.app/) before each hackathon to ensure they remain up-to-date. +Before each hackathon, we need to update the [bingo cards](https://nfcore-bingo.web.app/) to ensure they remain current. -1. [ ] Get the outreach google account credentials +1. [ ] Get the outreach google account credentials from `@core-team` 2. [ ] Log into the Firebase Dashboard: https://console.firebase.google.com/ 3. [ ] Click “Realtime Database” on the left 4. [ ] In the middle click “games” and navigate down the tree until you reach “lexicon” From df436ad4c7c982ce7da2c88d6cd8b738b6efc0bc Mon Sep 17 00:00:00 2001 From: nf-core-bot Date: Sat, 9 Nov 2024 13:14:31 +0000 Subject: [PATCH 07/16] [automated] Fix code linting --- .../docs/checklists/community_governance/core_team.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/content/docs/checklists/community_governance/core_team.mdx b/src/content/docs/checklists/community_governance/core_team.mdx index 0c19bded54..ab945b108d 100644 --- a/src/content/docs/checklists/community_governance/core_team.mdx +++ b/src/content/docs/checklists/community_governance/core_team.mdx @@ -23,14 +23,14 @@ This document outlines the steps to be performed when a new pipeline is accepted Instructions for uploading full-test AWS files for a pipeline to a S3 bucket: - [ ] Check Valid test data that can be uploaded: - - [ ] Small input data that maybe unreliable when downloaded from other repositories + - [ ] Small input data that maybe unreliable when downloaded from other repositories (e.g., limit total file size to a maximum of 10GB across all files) - - [ ] Very large files that cannot be reduced or subsetted. + - [ ] Very large files that cannot be reduced or subsetted. - [ ] When creating the pipeline directory in the S3 bucket, select the 'Amazon S3-managed keys (SSE-S3)` option. ## Activating Zenodo archiving of a new pipeline -Instructions for setting up Zenodo DOIs. +Instructions for setting up Zenodo DOIs. It's recommended that a core team member does these steps as it makes it easier for us to transfer to the nf-core Zenodo community. Before release: From 17f6da79fccda22be54b0aa60892e09072cbb982 Mon Sep 17 00:00:00 2001 From: Christopher Hakkaart Date: Mon, 11 Nov 2024 09:11:06 +0100 Subject: [PATCH 08/16] Update src/content/docs/checklists/community_governance/core_team.mdx Co-authored-by: Sateesh_Peri <33637490+sateeshperi@users.noreply.github.com> --- src/content/docs/checklists/community_governance/core_team.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/checklists/community_governance/core_team.mdx b/src/content/docs/checklists/community_governance/core_team.mdx index ab945b108d..902321d755 100644 --- a/src/content/docs/checklists/community_governance/core_team.mdx +++ b/src/content/docs/checklists/community_governance/core_team.mdx @@ -14,7 +14,7 @@ This document outlines the steps to be performed when a new pipeline is accepted 2. [ ] Core: Verify that the pipeline name follows the [pipeline naming guidelines](/docs/guidelines/pipelines/workflow_name). 3. [ ] Core: Create a slack channel with approved pipeline name. 4. [ ] Core: Ask the developers to join #pipeline-maintainers channel. -5. [ ] Core/Dev: Create the git repository using `nf-core create` and push it to GitHub. +5. [ ] Core/Dev: Create the git repository using `nf-core pipelines create` and push it to GitHub. 6. [ ] Core/Dev: Transfer the repository to nf-core GitHub organisation and delete the repository on local the machine/user account. 7. [ ] Core/Dev: Sync the nf-co.re pipelines page by manually triggering the GitHub action (website repo -> actions -> build json files and md-cache -> Run workflow -> from main). From 40fe9f2b01d5939fd912bb5416e65c1505c9513d Mon Sep 17 00:00:00 2001 From: "James A. Fellows Yates" Date: Wed, 13 Nov 2024 07:02:25 +0100 Subject: [PATCH 09/16] Apply suggestions from code review Co-authored-by: Christopher Hakkaart --- .../community_governance/core_team.mdx | 11 ++++++---- .../community_governance/maintainers_team.mdx | 20 +++++++++---------- 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/src/content/docs/checklists/community_governance/core_team.mdx b/src/content/docs/checklists/community_governance/core_team.mdx index 902321d755..7038d7f91a 100644 --- a/src/content/docs/checklists/community_governance/core_team.mdx +++ b/src/content/docs/checklists/community_governance/core_team.mdx @@ -6,7 +6,7 @@ markdownPlugin: checklist ## New pipeline onboarding -This document outlines the steps to be performed when a new pipeline is accepted via the #new-pipelines channel +Instructions for nf-core pipeline approval: 1. [ ] Core: Check proposal has received approval in #new-pipelines from either: - at least two members of the core team @@ -31,7 +31,10 @@ Instructions for uploading full-test AWS files for a pipeline to a S3 bucket: ## Activating Zenodo archiving of a new pipeline Instructions for setting up Zenodo DOIs. -It's recommended that a core team member does these steps as it makes it easier for us to transfer to the nf-core Zenodo community. + +:::note +It's recommended that a core team member transfers the DOI to the nf-core Zenodo community. +::: Before release: @@ -40,7 +43,7 @@ Before release: 3. [ ] Once connected, go back to Settings -> GitHub 4. [ ] Enable Zenodo archiving for all nf-core pipeline repositories by toggling the switch to `On` (including the one you want to assign). - It’s a good idea to enable this for all active pipelines, as DOIs will only be assigned upon release. - - Note: Some repositories (e.g. nf-core/exoseq) may not activate as they are archived. + - Note: Some repositories (e.g., nf-core/exoseq) may not activate as they are archived. 5. [ ] Inform the pipeline developers to make a release. Post release: @@ -70,7 +73,7 @@ Before each hackathon, we need to update the [bingo cards](https://nfcore-bingo. 1. [ ] Get the outreach google account credentials from `@core-team` 2. [ ] Log into the Firebase Dashboard: https://console.firebase.google.com/ 3. [ ] Click “Realtime Database” on the left -4. [ ] In the middle click “games” and navigate down the tree until you reach “lexicon” +4. [ ] Click “games” and navigate down the tree until you reach “lexicon” 5. [ ] Hover over “lexicon”, click on “+” to add entries. - key: Number - value: New board entry diff --git a/src/content/docs/checklists/community_governance/maintainers_team.mdx b/src/content/docs/checklists/community_governance/maintainers_team.mdx index 528fae7170..e26c4c5ef5 100644 --- a/src/content/docs/checklists/community_governance/maintainers_team.mdx +++ b/src/content/docs/checklists/community_governance/maintainers_team.mdx @@ -4,30 +4,30 @@ subtitle: Step-by-step guides for maintainers team tasks markdownPlugin: checklist --- -## Maintainers Team Onboarding +## Maintainers team onboarding -Team Leads: +Team lead: 1. [ ] Add member to [#team-maintainers](https://nfcore.slack.com/archives/C043UU89KKQ) 2. [ ] Add member to [Github group](https://github.com/orgs/nf-core/teams/maintainers) 3. [ ] Add member to Slack group -4. [ ] Add new maintainers to the [Maintainers team google calendar](https://calendar.google.com/calendar/u/0?cid=ZDA3MmVkOGI1NzQ0YWViOWE3ZjBkMDE4YjFjZWE1OGE5M2MwZDZlZTIyMzM1YWE5YzA0NTlmODg0YTZkMDNkZEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t) +4. [ ] Add member to the [Maintainers team google calendar](https://calendar.google.com/calendar/u/0?cid=ZDA3MmVkOGI1NzQ0YWViOWE3ZjBkMDE4YjFjZWE1OGE5M2MwZDZlZTIyMzM1YWE5YzA0NTlmODg0YTZkMDNkZEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t) New Maintainer: -1. [ ] Make a PR to nf-core website adding themselves to the [About > Governance > Maintainers section](https://nf-co.re/governance#maintainers) +1. [ ] Add self profile to the [About > Governance > Maintainers section](https://nf-co.re/governance#maintainers) -## Maintainers Team Yearly Maintenance +## Maintainers team membership :::note -Maintainers can be added at any point of the year at the nomination of the community. -Yearly maintenance is performed to ensure everything is up-to-date particularly in regards to members who step down. +New maintainers may be nominated by the community and join the team at any time. +Maintainers maintenance is performed yearly to ensure membership is up-to-date, particularly in regards to members who wish to step down due to new or changing commitments. ::: 1. [ ] Ask who wants to step down -2. [ ] Ask for nominations in maintainers meeting, discuss and approve +2. [ ] Ask for nominations, discuss, and approve new members 3. [ ] Invite nominees to join 4. [ ] Once accepted, nominee and team leads perform tasks [onboarding](#maintainers-team-onboarding) -5. [ ] Move members who are stepping down to alumni status on website in the [About > Governance > Maintainers section](https://nf-co.re/governance#maintainers) +5. [ ] Move members who step down to alumni status on the website in the [About > Governance > Maintainers section](https://nf-co.re/governance#maintainers) -6. [ ] Announce on [#announcements](https://nfcore.slack.com/archives/CE6P95170) +6. [ ] Announce new members on [#announcements](https://nfcore.slack.com/archives/CE6P95170) From 6dba19d66af6fcf250febc8014cd526754c765c0 Mon Sep 17 00:00:00 2001 From: Christopher Hakkaart Date: Thu, 14 Nov 2024 15:31:09 +0100 Subject: [PATCH 10/16] Apply suggestions from code review --- .../community_governance/core_team.mdx | 42 +++++++++++-------- 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/src/content/docs/checklists/community_governance/core_team.mdx b/src/content/docs/checklists/community_governance/core_team.mdx index 7038d7f91a..63aca3195a 100644 --- a/src/content/docs/checklists/community_governance/core_team.mdx +++ b/src/content/docs/checklists/community_governance/core_team.mdx @@ -9,24 +9,25 @@ markdownPlugin: checklist Instructions for nf-core pipeline approval: 1. [ ] Core: Check proposal has received approval in #new-pipelines from either: - - at least two members of the core team - - at least one member of the core team and one member of the maintainers team. + - Two members of the core team. + - One member of the core team and one member of the maintainers team. 2. [ ] Core: Verify that the pipeline name follows the [pipeline naming guidelines](/docs/guidelines/pipelines/workflow_name). 3. [ ] Core: Create a slack channel with approved pipeline name. 4. [ ] Core: Ask the developers to join #pipeline-maintainers channel. 5. [ ] Core/Dev: Create the git repository using `nf-core pipelines create` and push it to GitHub. 6. [ ] Core/Dev: Transfer the repository to nf-core GitHub organisation and delete the repository on local the machine/user account. -7. [ ] Core/Dev: Sync the nf-co.re pipelines page by manually triggering the GitHub action (website repo -> actions -> build json files and md-cache -> Run workflow -> from main). +7. [ ] Core/Dev: Sync the nf-co.re pipelines page by triggering the GitHub action (**Website repo > Actions > Build json files and md-cache > Run workflow > From main**). ## Uploading test data to s3 bucket Instructions for uploading full-test AWS files for a pipeline to a S3 bucket: -- [ ] Check Valid test data that can be uploaded: - - [ ] Small input data that maybe unreliable when downloaded from other repositories - (e.g., limit total file size to a maximum of 10GB across all files) - - [ ] Very large files that cannot be reduced or subsetted. -- [ ] When creating the pipeline directory in the S3 bucket, select the 'Amazon S3-managed keys (SSE-S3)` option. +1. [ ] Check Valid test data that can be uploaded: + :::note + Small input data that may be unreliable when downloaded from other repositories (e.g., limit total file size to a maximum of 10 GB across all files). + ::: +2. Check that large files that cannot be reduced or subsetted. +3. [ ] Create the pipeline directory in the S3 bucket and select the **Amazon S3-managed keys (SSE-S3)**. ## Activating Zenodo archiving of a new pipeline @@ -39,23 +40,28 @@ It's recommended that a core team member transfers the DOI to the nf-core Zenodo Before release: 1. [ ] Sign up on Zenodo and log in. -2. [ ] Connect your Github account (Go to Settings -> GitHub -> Connect Account). -3. [ ] Once connected, go back to Settings -> GitHub -4. [ ] Enable Zenodo archiving for all nf-core pipeline repositories by toggling the switch to `On` (including the one you want to assign). - - It’s a good idea to enable this for all active pipelines, as DOIs will only be assigned upon release. - - Note: Some repositories (e.g., nf-core/exoseq) may not activate as they are archived. +2. [ ] Select **Settings -> GitHub -> Connect Account** and connect your GitHub account. +3. [ ] Once connected, select **Settings -> GitHub**. +4. [ ] Enable Zenodo archiving for all nf-core pipeline repositories by toggling the switch to **On** (including the one you want to assign). + :::note + It’s a good idea to enable this for all active pipelines, as DOIs will only be assigned upon release. + ::: + + :::note + Some repositories (e.g., nf-core/exoseq) may not activate as they are archived. + ::: 5. [ ] Inform the pipeline developers to make a release. Post release: -1. [ ] Go to Zenodo and find the relevant repository in Settings -> Github. -2. [ ] Click through to the Zenodo 'record' page for the release. -3. [ ] On the record page, scroll down and look on the right-hand side and find the `Communities` box. Submit the record to the nf-core community. +1. [ ] Select **Settings -> Github** in Zenodo and find the relevant repository. +2. [ ] Click the Zenodo **Record** page for the release. +3. [ ] Find the **Communities** box on the record page and submit the record to the nf-core community. 4. [ ] Scroll down and again on the right-hand side of the page for the `Versions` box, copy the DOI for 'cite all versions by using the DOI ' (_not_ the specific release DOI). -5. [ ] Update the following files on the master branch of the pipeline repository: +5. [ ] Update files on the pipeline master branch: - **README.md**: Add the Zenodo Badge at the top and update the 'If you use this pipeline cite:' section at the bottom (make sure to uncomment this section too). - **Nextflow.config**: Update the manifest block to include the DOI. - - Commit these changes with a message like 'Add Zenodo ID after first release'. + - Commit these changes with the message 'Add Zenodo ID after first release'. ## Adding new community member to the GitHub organisation From b8963945086999efb31c8bcd241eb2a7009ea584 Mon Sep 17 00:00:00 2001 From: Christopher Hakkaart Date: Thu, 14 Nov 2024 15:31:53 +0100 Subject: [PATCH 11/16] Apply suggestions from code review --- .../community_governance/core_team.mdx | 22 ++++++++++--------- .../community_governance/maintainers_team.mdx | 4 ++-- 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/src/content/docs/checklists/community_governance/core_team.mdx b/src/content/docs/checklists/community_governance/core_team.mdx index 63aca3195a..f2b8bb9de5 100644 --- a/src/content/docs/checklists/community_governance/core_team.mdx +++ b/src/content/docs/checklists/community_governance/core_team.mdx @@ -57,9 +57,9 @@ Post release: 1. [ ] Select **Settings -> Github** in Zenodo and find the relevant repository. 2. [ ] Click the Zenodo **Record** page for the release. 3. [ ] Find the **Communities** box on the record page and submit the record to the nf-core community. -4. [ ] Scroll down and again on the right-hand side of the page for the `Versions` box, copy the DOI for 'cite all versions by using the DOI ' (_not_ the specific release DOI). +4. [ ] Copy the DOI for **Cite all versions by using the DOI**. 5. [ ] Update files on the pipeline master branch: - - **README.md**: Add the Zenodo Badge at the top and update the 'If you use this pipeline cite:' section at the bottom (make sure to uncomment this section too). + - **README.md**: Add the Zenodo Badge and update the **If you use this pipeline cite:** section. - **Nextflow.config**: Update the manifest block to include the DOI. - Commit these changes with the message 'Add Zenodo ID after first release'. @@ -69,21 +69,23 @@ Anyone can request to join the nf-core GitHub organisation via the #github-invit 1. [ ] Verify the request is reasonable (i.e., clearly not spam). 2. [ ] Send an invitation via [nf-core github teams](https://github.com/orgs/nf-core/teams) -3. [ ] Add them to the [nf-core contributors team](https://github.com/orgs/nf-core/teams/contributors) -4. [ ] Respond to the request on slack by reacting with ✅ on their message in #github-invitations channel (so they get their acceptance instructions). +3. [ ] Add new member to the [nf-core contributors team](https://github.com/orgs/nf-core/teams/contributors) +4. [ ] Respond to the #github-invitations channel request by reacting with the ✅ emoji. ## Updating online bingo cards Before each hackathon, we need to update the [bingo cards](https://nfcore-bingo.web.app/) to ensure they remain current. -1. [ ] Get the outreach google account credentials from `@core-team` +To update the bingo cards: + +1. [ ] Ask for the outreach google account credentials from `@core-team` 2. [ ] Log into the Firebase Dashboard: https://console.firebase.google.com/ -3. [ ] Click “Realtime Database” on the left -4. [ ] Click “games” and navigate down the tree until you reach “lexicon” -5. [ ] Hover over “lexicon”, click on “+” to add entries. +3. [ ] Select **Realtime Database**. +4. [ ] Select **games** and navigate down the tree until you reach **lexicon**. +5. [ ] Hover over **lexicon** and select **+** to add entries: - key: Number - value: New board entry -6. To delete entries: Click on the trash bin next to the given entry. +6. Select the trash bin next to the given entry to remove it. ## Backups @@ -95,7 +97,7 @@ The following items should be regularly backed up by a member of core team with This documents the steps that need to be performed when adding a new core team member: -1. [ ] Add to core team slack channel +1. [ ] Add to core team Slack channel 2. [ ] Add to GitHub core team 3. [ ] Add as owners on the GitHub org 4. [ ] Add to @core-team @outreach-team slack teams diff --git a/src/content/docs/checklists/community_governance/maintainers_team.mdx b/src/content/docs/checklists/community_governance/maintainers_team.mdx index e26c4c5ef5..4cd058ebb2 100644 --- a/src/content/docs/checklists/community_governance/maintainers_team.mdx +++ b/src/content/docs/checklists/community_governance/maintainers_team.mdx @@ -15,7 +15,7 @@ Team lead: New Maintainer: -1. [ ] Add self profile to the [About > Governance > Maintainers section](https://nf-co.re/governance#maintainers) +1. [ ] Add profile [**About > Governance > Maintainers**](https://nf-co.re/governance#maintainers) ## Maintainers team membership @@ -28,6 +28,6 @@ Maintainers maintenance is performed yearly to ensure membership is up-to-date, 2. [ ] Ask for nominations, discuss, and approve new members 3. [ ] Invite nominees to join 4. [ ] Once accepted, nominee and team leads perform tasks [onboarding](#maintainers-team-onboarding) -5. [ ] Move members who step down to alumni status on the website in the [About > Governance > Maintainers section](https://nf-co.re/governance#maintainers) +5. [ ] Move members who step down to alumni status on the website in [**About > Governance > Maintainers**](https://nf-co.re/governance#maintainers) 6. [ ] Announce new members on [#announcements](https://nfcore.slack.com/archives/CE6P95170) From e4ab405b1991d52b693a81322cc225b6ef210a32 Mon Sep 17 00:00:00 2001 From: Christopher Hakkaart Date: Thu, 14 Nov 2024 15:32:41 +0100 Subject: [PATCH 12/16] Update src/content/docs/checklists/community_governance/maintainers_team.mdx --- .../community_governance/maintainers_team.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/content/docs/checklists/community_governance/maintainers_team.mdx b/src/content/docs/checklists/community_governance/maintainers_team.mdx index 4cd058ebb2..9c1a8b74ec 100644 --- a/src/content/docs/checklists/community_governance/maintainers_team.mdx +++ b/src/content/docs/checklists/community_governance/maintainers_team.mdx @@ -24,10 +24,10 @@ New maintainers may be nominated by the community and join the team at any time. Maintainers maintenance is performed yearly to ensure membership is up-to-date, particularly in regards to members who wish to step down due to new or changing commitments. ::: -1. [ ] Ask who wants to step down -2. [ ] Ask for nominations, discuss, and approve new members -3. [ ] Invite nominees to join -4. [ ] Once accepted, nominee and team leads perform tasks [onboarding](#maintainers-team-onboarding) -5. [ ] Move members who step down to alumni status on the website in [**About > Governance > Maintainers**](https://nf-co.re/governance#maintainers) +1. [ ] Ask who wants to step down. +2. [ ] Ask for nominations, discuss, and approve new members. +3. [ ] Invite nominees to join. +4. [ ] Once accepted, nominee and team leads perform tasks [onboarding](#maintainers-team-onboarding). +5. [ ] Move members who step down to alumni status on the website in [**About > Governance > Maintainers**](https://nf-co.re/governance#maintainers). -6. [ ] Announce new members on [#announcements](https://nfcore.slack.com/archives/CE6P95170) +6. [ ] Announce new members on [#announcements](https://nfcore.slack.com/archives/CE6P95170). From 0f8e83c21e6175df5589d23527eb29fc357b2201 Mon Sep 17 00:00:00 2001 From: Christopher Hakkaart Date: Fri, 15 Nov 2024 08:21:11 +0100 Subject: [PATCH 13/16] Linter --- .../community_governance/core_team.mdx | 23 ++++++++++--------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/src/content/docs/checklists/community_governance/core_team.mdx b/src/content/docs/checklists/community_governance/core_team.mdx index f2b8bb9de5..96e6158a57 100644 --- a/src/content/docs/checklists/community_governance/core_team.mdx +++ b/src/content/docs/checklists/community_governance/core_team.mdx @@ -22,12 +22,12 @@ Instructions for nf-core pipeline approval: Instructions for uploading full-test AWS files for a pipeline to a S3 bucket: -1. [ ] Check Valid test data that can be uploaded: - :::note - Small input data that may be unreliable when downloaded from other repositories (e.g., limit total file size to a maximum of 10 GB across all files). - ::: -2. Check that large files that cannot be reduced or subsetted. -3. [ ] Create the pipeline directory in the S3 bucket and select the **Amazon S3-managed keys (SSE-S3)**. +1. [ ] Check Valid test data that can be uploaded: + :::note + Small input data that may be unreliable when downloaded from other repositories (e.g., limit total file size to a maximum of 10 GB across all files). + ::: +2. Check that large files that cannot be reduced or subsetted. +3. [ ] Create the pipeline directory in the S3 bucket and select the **Amazon S3-managed keys (SSE-S3)**. ## Activating Zenodo archiving of a new pipeline @@ -43,19 +43,20 @@ Before release: 2. [ ] Select **Settings -> GitHub -> Connect Account** and connect your GitHub account. 3. [ ] Once connected, select **Settings -> GitHub**. 4. [ ] Enable Zenodo archiving for all nf-core pipeline repositories by toggling the switch to **On** (including the one you want to assign). - :::note - It’s a good idea to enable this for all active pipelines, as DOIs will only be assigned upon release. - ::: - + :::note + It's a good idea to enable this for all active pipelines, as DOIs will only be assigned upon release. + ::: + :::note Some repositories (e.g., nf-core/exoseq) may not activate as they are archived. ::: + 5. [ ] Inform the pipeline developers to make a release. Post release: 1. [ ] Select **Settings -> Github** in Zenodo and find the relevant repository. -2. [ ] Click the Zenodo **Record** page for the release. +2. [ ] Click the Zenodo **Record** page for the release. 3. [ ] Find the **Communities** box on the record page and submit the record to the nf-core community. 4. [ ] Copy the DOI for **Cite all versions by using the DOI**. 5. [ ] Update files on the pipeline master branch: From 07438b30247f83c7faf5884c5b91d2c136292d9b Mon Sep 17 00:00:00 2001 From: Christopher Hakkaart Date: Fri, 15 Nov 2024 09:11:31 +0100 Subject: [PATCH 14/16] Move to docs folder --- .../content/docs/checklists/community_governance/core_team.mdx | 0 .../docs/checklists/community_governance/maintainers_team.mdx | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename {src => sites/docs/src}/content/docs/checklists/community_governance/core_team.mdx (100%) rename {src => sites/docs/src}/content/docs/checklists/community_governance/maintainers_team.mdx (100%) diff --git a/src/content/docs/checklists/community_governance/core_team.mdx b/sites/docs/src/content/docs/checklists/community_governance/core_team.mdx similarity index 100% rename from src/content/docs/checklists/community_governance/core_team.mdx rename to sites/docs/src/content/docs/checklists/community_governance/core_team.mdx diff --git a/src/content/docs/checklists/community_governance/maintainers_team.mdx b/sites/docs/src/content/docs/checklists/community_governance/maintainers_team.mdx similarity index 100% rename from src/content/docs/checklists/community_governance/maintainers_team.mdx rename to sites/docs/src/content/docs/checklists/community_governance/maintainers_team.mdx From 1b1e11ee59df12249fa8a22038b99144d921a663 Mon Sep 17 00:00:00 2001 From: Christopher Hakkaart Date: Fri, 15 Nov 2024 09:26:45 +0100 Subject: [PATCH 15/16] Final review with preview --- .../community_governance/core_team.mdx | 41 ++++++++++--------- .../community_governance/maintainers_team.mdx | 10 +++-- 2 files changed, 28 insertions(+), 23 deletions(-) diff --git a/sites/docs/src/content/docs/checklists/community_governance/core_team.mdx b/sites/docs/src/content/docs/checklists/community_governance/core_team.mdx index 96e6158a57..3285208e86 100644 --- a/sites/docs/src/content/docs/checklists/community_governance/core_team.mdx +++ b/sites/docs/src/content/docs/checklists/community_governance/core_team.mdx @@ -16,7 +16,8 @@ Instructions for nf-core pipeline approval: 4. [ ] Core: Ask the developers to join #pipeline-maintainers channel. 5. [ ] Core/Dev: Create the git repository using `nf-core pipelines create` and push it to GitHub. 6. [ ] Core/Dev: Transfer the repository to nf-core GitHub organisation and delete the repository on local the machine/user account. -7. [ ] Core/Dev: Sync the nf-co.re pipelines page by triggering the GitHub action (**Website repo > Actions > Build json files and md-cache > Run workflow > From main**). +7. [ ] Core/Dev: Sync the nf-co.re pipelines page by triggering the GitHub action + - Website repo > Actions > Build json files and md-cache > Run workflow > From main. ## Uploading test data to s3 bucket @@ -26,8 +27,8 @@ Instructions for uploading full-test AWS files for a pipeline to a S3 bucket: :::note Small input data that may be unreliable when downloaded from other repositories (e.g., limit total file size to a maximum of 10 GB across all files). ::: -2. Check that large files that cannot be reduced or subsetted. -3. [ ] Create the pipeline directory in the S3 bucket and select the **Amazon S3-managed keys (SSE-S3)**. +2. [ ] Check that large files that cannot be reduced or subsetted. +3. [ ] Select **Amazon S3-managed keys (SSE-S3)** and create the pipeline directory in the S3 bucket. ## Activating Zenodo archiving of a new pipeline @@ -39,16 +40,16 @@ It's recommended that a core team member transfers the DOI to the nf-core Zenodo Before release: -1. [ ] Sign up on Zenodo and log in. +1. [ ] Sign up and log in to Zenodo. 2. [ ] Select **Settings -> GitHub -> Connect Account** and connect your GitHub account. -3. [ ] Once connected, select **Settings -> GitHub**. -4. [ ] Enable Zenodo archiving for all nf-core pipeline repositories by toggling the switch to **On** (including the one you want to assign). +3. [ ] Select **Settings -> GitHub** once connected. +4. [ ] Toggle the **On** switch to enable Zenodo archiving for all nf-core pipeline repositories. :::note It's a good idea to enable this for all active pipelines, as DOIs will only be assigned upon release. ::: :::note - Some repositories (e.g., nf-core/exoseq) may not activate as they are archived. + Some repositories (e.g., nf-core/exoseq) may not be activate as they are archived. ::: 5. [ ] Inform the pipeline developers to make a release. @@ -60,9 +61,9 @@ Post release: 3. [ ] Find the **Communities** box on the record page and submit the record to the nf-core community. 4. [ ] Copy the DOI for **Cite all versions by using the DOI**. 5. [ ] Update files on the pipeline master branch: - - **README.md**: Add the Zenodo Badge and update the **If you use this pipeline cite:** section. - - **Nextflow.config**: Update the manifest block to include the DOI. - - Commit these changes with the message 'Add Zenodo ID after first release'. + - `README.md`: Add the Zenodo Badge and update the **If you use this pipeline cite** section. + - `Nextflow.config`: Update the manifest block to include the DOI. + - Commit these changes with the message "Add Zenodo ID after first release". ## Adding new community member to the GitHub organisation @@ -84,9 +85,9 @@ To update the bingo cards: 3. [ ] Select **Realtime Database**. 4. [ ] Select **games** and navigate down the tree until you reach **lexicon**. 5. [ ] Hover over **lexicon** and select **+** to add entries: - - key: Number - - value: New board entry -6. Select the trash bin next to the given entry to remove it. + - Key: Number + - Value: New board entry +6. [ ] Select the trash bin next to the given entry to remove it. ## Backups @@ -101,16 +102,16 @@ This documents the steps that need to be performed when adding a new core team m 1. [ ] Add to core team Slack channel 2. [ ] Add to GitHub core team 3. [ ] Add as owners on the GitHub org -4. [ ] Add to @core-team @outreach-team slack teams +4. [ ] Add to `@core-team` `@outreach-team` slack teams 5. [ ] Add as admin on slack 6. [ ] Add to hackMD team as Admin -7. [ ] Add to quay.io in team owners +7. [ ] Add to `quay.io` in team owners 8. [ ] Add to Tower organisation as owner 9. [ ] Add to nf-core google calendar(s) -10. [ ] Add to core@nf-co.re forwarder +10. [ ] Add to `core@nf-co.re` forwarder 11. [ ] Add to [Zenodo community](https://zenodo.org/communities/nf-core/records?q=&l=list&p=1&s=10) as admin -12. [ ] Create personal @nf-co.re email +12. [ ] Create personal `@nf-co.re` email 13. [ ] Update Website / About (get new member to check) -14. [ ] Tell new member to add nf-core apple core emoji as Status -15. [ ] Slack announcement -16. [ ] Social media announcement +14. [ ] Ask new member to add nf-core apple core emoji as Status +15. [ ] Make Slack announcement +16. [ ] Make Social media announcement diff --git a/sites/docs/src/content/docs/checklists/community_governance/maintainers_team.mdx b/sites/docs/src/content/docs/checklists/community_governance/maintainers_team.mdx index 9c1a8b74ec..42187d0b93 100644 --- a/sites/docs/src/content/docs/checklists/community_governance/maintainers_team.mdx +++ b/sites/docs/src/content/docs/checklists/community_governance/maintainers_team.mdx @@ -6,6 +6,8 @@ markdownPlugin: checklist ## Maintainers team onboarding +To add maintainers: + Team lead: 1. [ ] Add member to [#team-maintainers](https://nfcore.slack.com/archives/C043UU89KKQ) @@ -13,9 +15,9 @@ Team lead: 3. [ ] Add member to Slack group 4. [ ] Add member to the [Maintainers team google calendar](https://calendar.google.com/calendar/u/0?cid=ZDA3MmVkOGI1NzQ0YWViOWE3ZjBkMDE4YjFjZWE1OGE5M2MwZDZlZTIyMzM1YWE5YzA0NTlmODg0YTZkMDNkZEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t) -New Maintainer: +New member: -1. [ ] Add profile [**About > Governance > Maintainers**](https://nf-co.re/governance#maintainers) +1. [ ] Add profile to [**About > Governance > Maintainers**](https://nf-co.re/governance#maintainers) ## Maintainers team membership @@ -24,10 +26,12 @@ New maintainers may be nominated by the community and join the team at any time. Maintainers maintenance is performed yearly to ensure membership is up-to-date, particularly in regards to members who wish to step down due to new or changing commitments. ::: +To review mainterins team membership: + 1. [ ] Ask who wants to step down. 2. [ ] Ask for nominations, discuss, and approve new members. 3. [ ] Invite nominees to join. 4. [ ] Once accepted, nominee and team leads perform tasks [onboarding](#maintainers-team-onboarding). -5. [ ] Move members who step down to alumni status on the website in [**About > Governance > Maintainers**](https://nf-co.re/governance#maintainers). +5. [ ] Move members to alumni status on the website in [**About > Governance > Maintainers**](https://nf-co.re/governance#maintainers). 6. [ ] Announce new members on [#announcements](https://nfcore.slack.com/archives/CE6P95170). From d7970823f9cd1ef41e4a4122a0aa0e0cd32b2eee Mon Sep 17 00:00:00 2001 From: Christopher Hakkaart Date: Fri, 15 Nov 2024 09:27:05 +0100 Subject: [PATCH 16/16] Final review with preview again --- .../docs/checklists/community_governance/maintainers_team.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/sites/docs/src/content/docs/checklists/community_governance/maintainers_team.mdx b/sites/docs/src/content/docs/checklists/community_governance/maintainers_team.mdx index 42187d0b93..c59f1ab33a 100644 --- a/sites/docs/src/content/docs/checklists/community_governance/maintainers_team.mdx +++ b/sites/docs/src/content/docs/checklists/community_governance/maintainers_team.mdx @@ -33,5 +33,4 @@ To review mainterins team membership: 3. [ ] Invite nominees to join. 4. [ ] Once accepted, nominee and team leads perform tasks [onboarding](#maintainers-team-onboarding). 5. [ ] Move members to alumni status on the website in [**About > Governance > Maintainers**](https://nf-co.re/governance#maintainers). - 6. [ ] Announce new members on [#announcements](https://nfcore.slack.com/archives/CE6P95170).