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

Move Wave docs to Wave documentation #5072

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jason-seqera
Copy link
Contributor

This PR shifts the Wave-specific guides over to the Wave repo and the Wave documentation site at: https://docs.seqera.io/wave

This PR shifts the Wave-specific guides over to the Wave repo
and the Wave documentation site at: https://docs.seqera.io/wave
@jason-seqera jason-seqera self-assigned this Jun 17, 2024
@jason-seqera jason-seqera requested a review from a team as a code owner June 17, 2024 20:25
Copy link

netlify bot commented Jun 17, 2024

Deploy Preview for nextflow-docs-staging ready!

Name Link
🔨 Latest commit 07f182e
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-docs-staging/deploys/66709ba7b13b2e0008b9194e
😎 Deploy Preview https://deploy-preview-5072--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 site configuration.

Copy link
Member

@ewels ewels left a comment

Choose a reason for hiding this comment

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

LGTM 👍🏻

@jason-seqera - this repo needs signed commits, which is why the CI check is failing. Easy to fix:

git commit --amend --sign
# Accept / save commit message as before
git push --force
@pditommaso
Copy link
Member

I think we should keep on hold until we don't have the new wave docs ready

@ewels
Copy link
Member

ewels commented Jun 19, 2024

Ah I assumed that there was a paired PR to add these back into the Seqera docs. Yes agree, they should be added there before they're removed here.

@jason-seqera
Copy link
Contributor Author

@pditommaso @ewels - We could move over these tutorials in the meantime, though, and then that portion of the project would be complete. None of these specifically depend on the overall content refresh being complete.

@ewels
Copy link
Member

ewels commented Jun 19, 2024

Aha - it's here! seqeralabs/wave#516

Sorry, didn't see it before. Yes if we can merge that first ☝🏻 then the docs will appear at docs.seqera.io. Then I think it's fine to merge this PR as the content will still be available and we can point there.

So just a question of sequencing the merges correctly from my point of view.

@pditommaso is it not better to do this before before the big Wave docs rewrite? I feel like this content should probably be included in the docs review for the new wave docs, rather than being tacked on afterwards...

@pditommaso
Copy link
Member

I'm not okay with deleting the Wave docs from Nextflow until there's an update and comprehensive documentation for Wave.

My rationale: 1) moving pieces around just creates confusion, 2) the Wave docs are not blocked by this, and 3) there are many places, including Platform docs, that link the Wave docs in Nextflow.

@jason-seqera
Copy link
Contributor Author

This content now also lives here: https://docs.seqera.io/wave/nextflow

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 participants