Skip to content
This repository has been archived by the owner on Aug 20, 2024. It is now read-only.

Commit

Permalink
Get it working hopefully on both GitHub + mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
ewels committed Apr 22, 2024
1 parent a070231 commit 53fd1bf
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
# ![nf-validation](docs/images/nf-validation.svg)

## πŸ“š Docs πŸ‘‰πŸ» <https://nextflow-io.github.io/nf-validation>

!!! warning

<div class="admonition warning" markdown>

<!-- prettier-ignore -->
> [!IMPORTANT]
> **`nf-validation` has now been renamed to `nf-schema`. The `nf-validation` plugin will not receive any future updates.**
Expand All @@ -17,7 +11,7 @@
> plugins { id '[email protected]' }
> ```
</div>
## πŸ“š Docs πŸ‘‰πŸ» <https://nextflow-io.github.io/nf-validation>

**A Nextflow plugin to work with validation of pipeline parameters and sample sheets.**

Expand Down
12 changes: 11 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,14 @@ description: Nextflow plugin for sample sheet validation

==}

--8<-- "README.md:6:"
!!! warning "`nf-validation` has now been renamed to `nf-schema`."

**`nf-validation` has now been renamed to `nf-schema`. The `nf-validation` plugin will not receive any future updates.**
**Please update your pipelines to use [`nf-schema`](https://github.com/nextflow-io/nf-schema) instead.**
This change was necessary to prevent older versions of `nf-core` pipelines from with unpinned plugin references from breaking when updating to the latest version of `nf-validation`.
**Please pin the version of `nf-schema` in your pipeline's `nextflow.config` file:**
```nextflow
plugins { id '[email protected]' }
```

--8<-- "README.md:18:"

0 comments on commit 53fd1bf

Please sign in to comment.