Skip to content

Update plugins documentation #6033

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

Open
wants to merge 31 commits into
base: master
Choose a base branch
from

Conversation

christopher-hakkaart
Copy link
Collaborator

No description provided.

Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Copy link

netlify bot commented May 5, 2025

Deploy Preview for nextflow-docs-staging ready!

Name Link
🔨 Latest commit 0180c86
🔍 Latest deploy log https://app.netlify.com/projects/nextflow-docs-staging/deploys/689f9daed5b81700084474c3
😎 Deploy Preview https://deploy-preview-6033--nextflow-docs-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@ewels ewels mentioned this pull request May 5, 2025
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
@bentsherman

This comment was marked as resolved.

@christopher-hakkaart

This comment was marked as resolved.

@pditommaso

This comment was marked as resolved.

Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
@bentsherman

This comment was marked as resolved.

Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
@bentsherman

This comment was marked as resolved.

@christopher-hakkaart

This comment was marked as resolved.

Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
@bentsherman

This comment was marked as resolved.

@bentsherman bentsherman marked this pull request as ready for review May 9, 2025 21:57
@bentsherman bentsherman requested a review from a team as a code owner May 9, 2025 21:57
@bentsherman bentsherman requested a review from pditommaso May 9, 2025 21:57
@bentsherman
Copy link
Member

I have updated the migration guide and various private beta callouts in such a way that I feel comfortable merging this PR now, even ahead of the plugin registry deployment.

To do this, I added a "Timeline" section to the migration guide which lays out our planned changes for the next few releases. This plan is taken from an internal planning doc where we reached some agreement.

The rest of the plugin docs direct you to this timeline via the callouts so that it's clear to anyone looking into the new Gradle plugin that there are some strings attached.

The tl;dr is that we will close the legacy plugin index to new PRs, but keep it in sync with the plugin registry for a time. Eventually after that, we can freeze the legacy index and remove it from new versions of Nextflow when we're ready.

This two-way sync during the transition period will make adopting the Gradle plugin as seamless as possible -- developers can use the new Gradle plugin with confidence that their plugin releases will continue to be accessible to users who aren't on the new registry yet.

Copy link
Collaborator Author

@christopher-hakkaart christopher-hakkaart left a comment

Choose a reason for hiding this comment

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

I've added a few suggestions. Mostly removing words.

I would unlist the timeline H3 headings so they don't clutter the side navigation. But everything is optional if you think meaning is lost.

@pditommaso pditommaso force-pushed the master branch 3 times, most recently from b4b321e to 069653d Compare June 4, 2025 18:54
@bentsherman bentsherman added this to the 25.10 milestone Jul 14, 2025
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
@bentsherman
Copy link
Member

I rebased the PR and squashed my commits to make it easier to maintain with master.

Also documented the NXF_PLUGINS_INDEX_URL which is how users opt-in to the plugin registry.

@christopher-hakkaart now that we have tutorials and guides, I'm not sure which one you intended for the gradle plugin / plugin registry pages. Also might be worth giving the PR another once-over since it was sitting for a while

@christopher-hakkaart
Copy link
Collaborator Author

Thanks @bentsherman . I'll go through the PR and think about where the pages live and look for anything that might be stale or don't make sense anymore.

Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
@@ -0,0 +1,53 @@
(nf-template-page)=

# Example: nf-plugin-template
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This page is orphaned. It was originally created as an example before we had the create command. Can delete unless you think there is value in keeping it.

Signed-off-by: Christopher Hakkaart <chris.hakkaart@seqera.io>
Copy link
Collaborator Author

@christopher-hakkaart christopher-hakkaart left a comment

Choose a reason for hiding this comment

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

@bentsherman I've pushed some changes for small fixes/alignment. There is one orphaned page (which I think can be removed), and one comment about the example. Otherwise I'm happy.

Comment on lines +27 to +29
```console
nf-hello
├── COPYING
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is missing .github/workflows, is this a part of the create command? I can see it in the template but it wasn't generated when I tested. I may be using an older version.

Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
@pditommaso
Copy link
Member

@christopher-hakkaart i've updated the docs to reflect latests changes. see
0180c86

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants