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

nf-core/tools v3.0.0 preparation: update docs for new command nf-core pipelines create #2742

Merged
merged 41 commits into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
613cd38
update docs fro new command nf-core pipelines create
mirpedrol Sep 26, 2024
6aaba59
[automated] Fix code linting
nf-core-bot Sep 26, 2024
cb3446a
update all nf-core commands to nf-core pipelnes
mirpedrol Sep 26, 2024
6c50a17
[automated] Fix code linting
nf-core-bot Sep 26, 2024
ea4f4ae
fix Features component
mashehu Sep 30, 2024
b05c04d
add/update deps
mashehu Sep 30, 2024
1bd032d
Add first version of the announcement blog post
mashehu Oct 1, 2024
6a837b8
Merge branch 'main' of github.com:nf-core/website into pipelines-crea…
mashehu Oct 3, 2024
f316e1c
update lock file
mashehu Oct 3, 2024
29e5604
start adding merge conflict examples
mashehu Oct 3, 2024
cd4c850
give author advice
mashehu Oct 4, 2024
daa327a
explain important template changes
mirpedrol Oct 4, 2024
65e27c9
Merge branch 'main' into pipelines-create-docs
mashehu Oct 4, 2024
88dff6d
specify how to resolve
mashehu Oct 4, 2024
cd07cb2
Merge branch 'pipelines-create-docs' of github.com:mirpedrol/website …
mashehu Oct 4, 2024
01bd225
add description about step-wise sync
mashehu Oct 4, 2024
f14c592
clarify some sync steps
mashehu Oct 7, 2024
b8f7958
switch order of sections
mashehu Oct 7, 2024
ef2c930
Standardized heading capitalization, add more merge conflict examples
mashehu Oct 7, 2024
c110e2a
fix linting and add `nextflow.config` advice
mashehu Oct 7, 2024
c2cea8c
add ch_samplesheet section
mashehu Oct 7, 2024
ce20c54
add link to migration guide
mashehu Oct 7, 2024
eb7e00e
first try on an intro paragraph
mashehu Oct 7, 2024
7f48dbc
break highlits points and list changed commands
mirpedrol Oct 7, 2024
3854e63
add comparison
mashehu Oct 7, 2024
571e29c
Merge branch 'pipelines-create-docs' of github.com:mirpedrol/website …
mashehu Oct 7, 2024
e0455a8
make command transition a table for better syntax highilghting
mashehu Oct 7, 2024
1fa73ed
Apply suggestions from code review
mashehu Oct 7, 2024
03ab45f
update frontmatter
mashehu Oct 7, 2024
ba8fee2
Merge branch 'pipelines-create-docs' of github.com:mirpedrol/website …
mashehu Oct 7, 2024
18790b3
hide too deep headings
mashehu Oct 7, 2024
5d8ed0b
remove duplicated text
mashehu Oct 7, 2024
a5ed748
add warning about python 3.8 EOL
mashehu Oct 7, 2024
1a3b2b8
update intro
mashehu Oct 7, 2024
9320e47
add sub-bullets
mashehu Oct 7, 2024
f9cb3d9
Apply suggestions from code review
mashehu Oct 7, 2024
5d72a36
change phrasing
mashehu Oct 7, 2024
87c97e4
Merge branch 'pipelines-create-docs' of github.com:mirpedrol/website …
mashehu Oct 7, 2024
2700c5f
add asciinema recording of TUI
mashehu Oct 8, 2024
b988f58
update embedded video
mashehu Oct 8, 2024
29738a0
asciinema 👎🏻 yotube 👍🏻
mashehu Oct 8, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
409 changes: 208 additions & 201 deletions package-lock.json

Large diffs are not rendered by default.

21 changes: 11 additions & 10 deletions sites/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,16 @@
"test": "playwright test"
},
"dependencies": {
"@astrojs/mdx": "^3.1.3",
"@astrojs/netlify": "^5.4.0",
"@iconify-json/fa": "^1.1.8",
"@iconify-json/fa-brands": "^1.1.8",
"@iconify-json/file-icons": "^1.1.9",
"@iconify-json/logos": "^1.1.43",
"@iconify-json/mdi": "^1.1.67",
"@iconify-json/octicon": "^1.1.56",
"@iconify/utils": "^2.1.25",
"svelte-exmarkdown": "^3.0.5"
"@astrojs/mdx": "^3.1.7",
"@astrojs/netlify": "^5.5.3",
"@iconify-json/fa": "^1.2.0",
"@iconify-json/fa-brands": "^1.2.0",
"@iconify-json/file-icons": "^1.2.0",
"@iconify-json/logos": "^1.2.0",
"@iconify-json/mdi": "^1.2.0",
"@iconify-json/octicon": "^1.2.0",
"@iconify/utils": "^2.1.33",
"svelte-exmarkdown": "^3.0.5",
"yaml": "^2.5.1"
}
}
8 changes: 4 additions & 4 deletions sites/docs/src/content/docs/checklists/pipeline_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If this is your first release, make sure to follow the [first release tutorial](

1. [ ] Check the pipeline follows [nf-core guidelines](/docs/guidelines/pipelines/overview).
2. [ ] All continuous-integration tests on the `dev` branch should be passing
- [ ] Check the output of `nf-core lint` for warnings and address all that you can
- [ ] Check the output of `nf-core pipelines lint` for warnings and address all that you can
- [ ] Update any software dependencies that are out of date.
The linting will warn about available updates via automated API calls to (bio-)conda
3. [ ] Check that there are no outstanding issues that need to be addressed, especially bug reports.
Expand All @@ -25,11 +25,11 @@ If this is your first release, make sure to follow the [first release tutorial](

1. [ ] On your fork, bump the version number of the `dev` branch to a release version
- [ ] For example, `1.0.0dev` becomes `1.0.0`
- [ ] Use the `nf-core bump-version` command to make the changes, eg: navigate to the pipeline directory and run `nf-core bump-version 1.0.0`
- [ ] Use the `nf-core pipelines bump-version` command to make the changes, eg: navigate to the pipeline directory and run `nf-core pipelines bump-version 1.0.0`
- [ ] Please make sure to use strictly numeric release numbers
- [ ] Use [Semantic Versioning](https://semver.org/)
- [ ] Make sure to update the version in any pipeline diagrams and other figures
2. [ ] Run `nf-core lint --release` and check that there are no test failures for release.
2. [ ] Run `nf-core pipelines lint --release` and check that there are no test failures for release.
3. [ ] Check that `CHANGELOG.md` includes everything that has been added/fixed in this release, update the version number above the changes, and optionally add a human-readable release name (e.g. using a [code name generator](http://www.codenamegenerator.com/))
- [ ] We recommend you also add the GitHub handle of the main contributors of each CHANGELOG entry (author, and significant reviewers etc.). This will mean each release on GitHub will display each contributors icons for extra visibility and recognition.
4. [ ] [Open a Pull Request (PR)](https://help.github.com/en/articles/creating-a-pull-request) with these changes from your fork to the `dev` branch on the nf-core repository.
Expand Down Expand Up @@ -62,7 +62,7 @@ The last step is to bump up the pipeline version number in the development branc
1. [ ] Make sure the dev branch on your fork is up to date
2. [ ] On a new branch, bump to a new `dev` version
- [ ] For example, `1.0.0` becomes `1.1.0dev`
- [ ] Use the `nf-core bump-version` command to make the changes, eg: navigate to the pipeline directory and run `nf-core bump-version 1.1.0dev`
- [ ] Use the `nf-core pipelines bump-version` command to make the changes, eg: navigate to the pipeline directory and run `nf-core pipelines bump-version 1.1.0dev`
3. [ ] Update the `CHANGELOG.md` to include a new section for this new version
4. [ ] [Open a Pull Request (PR)](https://help.github.com/en/articles/creating-a-pull-request) with these changes from your fork to the `dev` branch on the nf-core repository.
5. [ ] (first release only) After the first release of the pipeline you will need to add the DOI manually into the main `README.md` for the pipeline:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ describing what each file is and what it does.

## Files

You will find the following files in each nf-core pipeline. They are automatically generated, when running `nf-core create`.
You will find the following files in each nf-core pipeline. They are automatically generated, when running `nf-core pipelines create`.

| Filename | Description  |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `main.nf` | This is the main nextflow file which will get executed if the pipeline is run. Typically, parameters are initialized and validated in this script before a workflow from the `workflows/` directory is called for execution. |
| `nextflow.config` | The main nextflow configuration file. It contains the default pipeline parameters, nextflow configuration options and information like pipeline and minimum nextflow version, among others. The `nextflow.config` also defines different configuration profiles that can be used to run the pipeline. See the [Configuration docs](/docs/usage/getting_started/configuration) for more information. |
| `README.md` | Basic information about the pipeline and usage |
| `nextflow_schema.json` | The JSON schema file is used for pipeline parameter specification. This is automatically created using the `nf-core schema build` command. It is used for printing command-line help, validating input parameters, building the website docs and for building pipeline launch interfaces (web and cli). |
| `nextflow_schema.json` | The JSON schema file is used for pipeline parameter specification. This is automatically created using the `nf-core pipelines schema build` command. It is used for printing command-line help, validating input parameters, building the website docs and for building pipeline launch interfaces (web and cli). |
| `CHANGELOG.md` | Information about the changes made to the pipeline for each release. |
| `LICENSE` | The license - should be MIT |
| `CODE_OF_CONDUCT.md` | The nf-core code of conduct. |
Expand Down
2 changes: 1 addition & 1 deletion sites/docs/src/content/docs/guidelines/graphic_design.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ All information for the nf-core logo can be seen at the [nf-core/logos GitHub re
| Monochrome - dark background | <img class="bg-dark d-block p-2" src="https://raw.githubusercontent.com/nf-core/logos/master/nf-core-logos/nf-core-logo-mono-white.png" width="300"> | [PNG](https://github.com/nf-core/logos/blob/master/nf-core-logos/nf-core-logo-mono-white.png) <br> [SVG](https://github.com/nf-core/logos/blob/master/nf-core-logos/nf-core-logo-mono-white.svg) <br> [Adobe Illustrator `.ai`](https://github.com/nf-core/logos/blob/master/nf-core-logos/nf-core-logo-mono-white.ai) |
| Square | <img src="https://raw.githubusercontent.com/nf-core/logos/master/nf-core-logos/nf-core-logo-square.png" width="60"> | [PNG](https://github.com/nf-core/logos/blob/master/nf-core-logos/nf-core-logo-square.png) <br> [SVG](https://github.com/nf-core/logos/blob/master/nf-core-logos/nf-core-logo-square.svg) <br> [Adobe Illustrator `.ai`](https://github.com/nf-core/logos/blob/master/nf-core-logos/nf-core-logo-square.ai) |

The `nf-core create` command will generate a logo for your pipeline automatically.
The `nf-core pipelines create` command will generate a logo for your pipeline automatically.
However, you can also do this yourself by visiting [https://nf-co.re/logo/pipelinename](https://nf-co.re/logo/pipelinename), where `pipelinename` can be anything.

Please note that nf-core is a separate entity from Nextflow.
Expand Down
4 changes: 2 additions & 2 deletions sites/docs/src/content/docs/guidelines/pipelines/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ All nf-core pipelines _must_ follow the following guidelines:
- [Standardised parameters](/docs/guidelines/pipelines/requirements/parameters): Strive to have standardised usage.
- [Single command](/docs/guidelines/pipelines/requirements/single_command): Pipelines should run in a single command.
- [Keywords](/docs/guidelines/pipelines/requirements/keywords): Excellent documentation and GitHub repository keywords.
- [Pass lint tests](/docs/guidelines/pipelines/requirements/linting): The pipeline must not have any failures in the `nf-core lint` tests.
- [Pass lint tests](/docs/guidelines/pipelines/requirements/linting): The pipeline must not have any failures in the `nf-core pipelines lint` tests.
- [Credits and Acknowledgements](/docs/guidelines/pipelines/requirements/acknowledgements): Pipelines must properly acknowledge prior work.
- [Minimum inputs](/docs/guidelines/pipelines/requirements/minimum_inputs): Pipelines should be able to run with as little input as possible.
- [Use nf-core git branches](/docs/guidelines/pipelines/requirements/git_branches): Use `master`, `dev` and `TEMPLATE`.
Expand All @@ -77,7 +77,7 @@ Indeed, numerous pipelines outside of nf-core now extensively use and contribute

If using nf-core tools and especially the template, please don't call your pipeline `nf-core/<yourpipeline>`.
Please say that your pipeline _"uses"_ nf-core rather than rather than _"is"_ nf-core.
Remember that you can generate a pipeline with `nf-core create` that excludes nf-core branding.
Remember that you can generate a pipeline with `nf-core pipelines create` that excludes nf-core branding.
Citation and acknowledgement of the work that goes into these tools and templates is welcome.

> Non nf-core pipelines can be added to [nextflow-io/awesome-nextflow](https://github.com/nextflow-io/awesome-nextflow) for added visibility.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Pass lint tests
subtitle: The pipeline must not have any failures in the `nf-core lint` tests
subtitle: The pipeline must not have any failures in the `nf-core pipelines lint` tests
menu:
main:
weight: 130
---

In order to automate and standardise the nf-core best practices, we have built a code linting tool.
These tests are run by the [nf-core/tools](https://github.com/nf-core/tools) package.
The `nf-core lint` command must be run by continuous integration tests on GitHub Actions and must be passing before release.
The `nf-core pipelines lint` command must be run by continuous integration tests on GitHub Actions and must be passing before release.

You can see the list of tests and how to pass them on the [error codes page](https://nf-co.re/tools).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ menu:

All nf-core pipelines must be built using the nf-core template.

Workflows should be started using the `nf-core create` command which makes a new git repository and the initial commits and branches.
Workflows should be started using the `nf-core pipelines create` command which makes a new git repository and the initial commits and branches.
This is to ensure that the automated sync process that keeps all nf-core pipelines up to date can work. See the [sync docs](/docs/tutorials/sync/overview) for details.

Where possible, workflow authors should do their best to follow nf-core conventions for filenames and code locations.
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ shortTitle: bump-version
weight: 90
---

When releasing a new version of a nf-core pipeline, version numbers have to be updated in several different places. The helper command `nf-core bump-version` automates this for you to avoid manual errors (and frustration!).
When releasing a new version of a nf-core pipeline, version numbers have to be updated in several different places. The helper command `nf-core pipelines bump-version` automates this for you to avoid manual errors (and frustration!).

The command uses results from the linting process, so will only work with workflows that pass these tests.

Usage is `nf-core bump-version <new_version>`, eg:
Usage is `nf-core pipelines bump-version <new_version>`, eg:

<!-- RICH-CODEX
working_dir: tmp/nf-core-nextbigthing
-->

![`nf-core bump-version 1.1`](/images/tools/nf-core-bump-version.svg)
![`nf-core pipelines bump-version 1.1`](/images/tools/nf-core-bump-version.svg)

You can change the directory from the current working directory by specifying `--dir <pipeline_dir>`. To change the required version of Nextflow instead of the pipeline version number, use the flag `--nextflow`.
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ shortTitle: create-logo
weight: 110
---

The `nf-core create-logo` command creates a logo for your pipeline based on the nf-core template and the pipeline name. You can specify the width of the logo in pixels with the `--width` flag. Additionally, you can specify the output format to be either `png` or `svg` with the `--format` flag. The default format is `png`.
The `nf-core pipelines create-logo` command creates a logo for your pipeline based on the nf-core template and the pipeline name. You can specify the width of the logo in pixels with the `--width` flag. Additionally, you can specify the output format to be either `png` or `svg` with the `--format` flag. The default format is `png`.

Usage is `nf-core create-logo <text>`, eg:
Usage is `nf-core pipelines create-logo <text>`, eg:

<!-- RICH-CODEX
working_dir: tmp
-->

![`nf-core create-logo nextbigthing`](/images/tools/nf-core-create-logo.svg)
![`nf-core pipelines create-logo nextbigthing`](/images/tools/nf-core-create-logo.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ weight: 30
---

Sometimes it is easier to manually edit a parameter file than to use the web interface or interactive commandline wizard
provided by `nf-core launch`, for example when running a pipeline with many options on a remote server without a graphical interface.
provided by `nf-core pipelines launch`, for example when running a pipeline with many options on a remote server without a graphical interface.

You can create a parameter file with all parameters of a pipeline with the `nf-core create-params-file` command.
You can create a parameter file with all parameters of a pipeline with the `nf-core pipelines create-params-file` command.
This file can then be passed to `nextflow` with the `-params-file` flag.

This command takes one argument - either the name of a nf-core pipeline which will be pulled automatically,
Expand Down
Loading
Loading