Add documentation for using cross-organisational components #2816
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add documentation for cross-organisational subworkflows
* main: add infra group to hackathon fix components.json
✅ Deploy Preview for nf-core-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for nf-core-main-site ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mashehu
requested changes
Oct 25, 2024
sites/docs/src/content/docs/tutorials/external_usage/cross_organisational_subworkflows.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/tutorials/external_usage/cross_organisational_subworkflows.md
Outdated
Show resolved
Hide resolved
Comment on lines
+38
to
+50
| If you're using cross-organisational subworkflows in your repository, be aware that you must also specify a different JSON schema | ||
| to lint the `meta.yml` files for your subworkflows. | ||
| To do this, just change the `components` section type to allow both objects and strings. | ||
|
|
||
| ```json | ||
| "components": { | ||
| "type": "array", | ||
| "description": "Modules and subworkflows used in the subworkflow", | ||
| "items": { | ||
| "type": ["object", "string"] | ||
| }, | ||
| "minItems": 0 | ||
| }, |
There was a problem hiding this comment.
I think it's easier to just add these changes to the schema in the modules repo
There was a problem hiding this comment.
It won`t be added to the main modules repo, I believe, but I am adding it to the nf-core-test repo. I can remove this section and just link to the file there.
Co-authored-by: Matthias Hörtenhuber <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This documentation refers to the feature to be implemented through PR nf-core/tools#3083, which enables subworkflows with components from more than one remote (i.e. organisations). More about the feature itself and implementation details can be found there.
The current structure for the documentation was based on a suggestion in the original feature PR.
I'll leave this PR as a draft until the feature gets approved for merging.
CC @muffato who has been assisting me with both the feature and the documentation for it.
@netlify /docs/tutorials/external_usage/cross_organisational_subworkflows