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

Build the current docs on master too #184

Merged
merged 2 commits into from
Mar 22, 2024
Merged

Build the current docs on master too #184

merged 2 commits into from
Mar 22, 2024

Conversation

ewels
Copy link
Member

@ewels ewels commented Mar 22, 2024

Now that we're automating the build of the docs, I figure we can show the latest development docs off master too.

Updated the website build to trigger a nightly build to make sure that they're always up to date.

Signed-off-by: Phil Ewels <phil.ewels@seqera.io>
Copy link

netlify bot commented Mar 22, 2024

Deploy Preview for nextflow-staging ready!

Name Link
🔨 Latest commit fb76c57
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-staging/deploys/65fd9a2fbc07ff00084c4d34
😎 Deploy Preview https://deploy-preview-184--nextflow-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 70 (🔴 down 10 from production)
Accessibility: 80 (no change from production)
Best Practices: 92 (no change from production)
SEO: 77 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

@pditommaso
Copy link
Member

Where is this going to be pushed?

@ewels
Copy link
Member Author

ewels commented Mar 22, 2024

Where is this going to be pushed?

It's extending the current publishing system that was merged in the Astro rewrite:

  1. GitHub action fires (push, cron etc)
  2. Action runs the npm run build command
  3. This command does type checking on the website and runs the website static build, then runs the build_docs.sh script
  4. The build_docs.sh script is the one modified in this PR. It clones the Nextflow repo, checks out the relevant tags / branches, builds the docs and adds them on top of the built static astro website.
  5. The action goes on to run make publish and make invalidate
  6. Makefile pushes to cloudflare and then invalidates cloudflare cache

A bit convoluted, I set it up this way to try to make the process as familiar as possible 😅 e.g. it uses the exact same makefile commands as before for publishing.

@ewels
Copy link
Member Author

ewels commented Mar 22, 2024

So sorry, TLDR - it'll be published at https://nextflow.io/docs/dev

@pditommaso
Copy link
Member

So sorry, TLDR

😆

Should we do https://www.nextflow.io/docs/master/ for consistency with the branch name?

@bentsherman
Copy link
Member

I think we should rename latest to stable. All three of these docs builds are the "latest" in a certain sense -- latest stable, latest edge, latest master -- and I think this is confusing for people

@ewels
Copy link
Member Author

ewels commented Mar 22, 2024

Happy to do master - if you're sure that you're not going to rename to main any time soon? 😅

@bentsherman I had thought the same, but I'm not keen on changing the URL at the moment as there are so many links out in the wild pointing to it. Not sure that the reward is worth the change.

Signed-off-by: Phil Ewels <phil.ewels@seqera.io>
@ewels
Copy link
Member Author

ewels commented Mar 22, 2024

Should we do https://www.nextflow.io/docs/master/ for consistency with the branch name?

Done ✅

@pditommaso pditommaso merged commit a3f1f66 into master Mar 22, 2024
6 checks passed
@pditommaso pditommaso deleted the build-dev-docs branch March 22, 2024 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants