Skip to content

Improve data lineage docs #6044

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

Merged
merged 3 commits into from
May 9, 2025
Merged

Conversation

ewels
Copy link
Member

@ewels ewels commented May 7, 2025

No description provided.

@ewels ewels requested a review from christopher-hakkaart May 7, 2025 11:04
@ewels ewels requested a review from a team as a code owner May 7, 2025 11:04
Copy link

netlify bot commented May 7, 2025

Deploy Preview for nextflow-docs-staging canceled.

Name Link
🔨 Latest commit 83f43f0
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-docs-staging/deploys/681e5a2a605bf00008eaf2e5

@pditommaso
Copy link
Member

I think we should mark this feature as "Preview" in this release.

@jorgee
Copy link
Contributor

jorgee commented May 8, 2025

I think we should mark this feature as "Preview" in this release.

Do you mean adding a warning message when lineage is activated? or adding workflow.preview option? I think the second is not needed as there is a specific lineage.enabled option, right?

@pditommaso
Copy link
Member

Just in the docs

@bentsherman
Copy link
Member

The lineage command is already marked as experimental in the docs

@pditommaso
Copy link
Member

Good, worth adding the main lineage section

@bentsherman
Copy link
Member

Not sure what you mean, there is no main lineage section

@bentsherman
Copy link
Member

Rather, the lineage command is the main section

@bentsherman
Copy link
Member

From our discussion today, I will add a guide for using data lineage so that we have something more comprehensive without bloating the CLI docs

@bentsherman bentsherman changed the title Added a couple of docs admonitions about things that tripped me up Improve data lineage docs May 8, 2025
@bentsherman bentsherman self-assigned this May 9, 2025
@ewels
Copy link
Member Author

ewels commented May 9, 2025

Are we happy to merge this PR and do the guide in a different one @bentsherman ?

Signed-off-by: Ben Sherman <[email protected]>
@bentsherman bentsherman force-pushed the lineage-admonitions branch from f390afa to 4355179 Compare May 9, 2025 19:06
@bentsherman
Copy link
Member

Ready to go. The guide covers all the basic usages, as well as the tips about global config and setting the output directory. It does not cover the use of labels because I don't have a real-world example on hand for that. We can work on that in a separate PR.

I was going to merge, but I'm being blocked by this failing google test. Not sure why it's failing on only some PRs.

@bentsherman bentsherman merged commit 7f7fb63 into nextflow-io:master May 9, 2025
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants