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

Convert to markdown + mkdocs #127

Merged
merged 58 commits into from
Feb 1, 2023
Merged

Convert to markdown + mkdocs #127

merged 58 commits into from
Feb 1, 2023

Conversation

ewels
Copy link
Member

@ewels ewels commented Jan 27, 2023

Converted training material to markdown, using mkdocs material.

Reasoning:

  • We want to standardise on using markdown everywhere
  • We may soon want to support internationalisation, mkdocs material does this well
  • More consistent with other docs
  • Better styling, navigation, accessibility
  • Timing: May be moving from Seqera to Nextflow branding for the training material

Potentially controversial points:

  • I deleted the AWS docs as these aren't used anywhere
    • About half of the content is duplicated into the executors / deployment scenarios docs
    • The docs are long and super detailed. They're not used anywhere that I can see, which makes them high risk for drifting out of date. IMHO better to delete - they're in the git history if we need them in the future.

TODO:

  • Convert asciidoc files to markdown using this method
  • Set up prettier markdown formatting
  • Set up mkdocs
  • Convert asciidoc admonitions to mkdocs material
  • Repeat for nextflow-handson training
  • Manually review all markdown files
    • index.md
    • setup.md
    • intro.md
    • rnaseq_pipeline.md
    • containers.md
    • channels.md
    • processes.md
    • operators.md
    • groovy.md
    • modules.md
    • config.md
    • executors.md
    • tower.md
    • cache_and_resume.md
    • debugging.md
  • Set up translations
  • Look into numbered headings

@netlify
Copy link

netlify bot commented Jan 27, 2023

Deploy Preview for nextflow-training ready!

Name Link
🔨 Latest commit a1b468d
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-training/deploys/63da5567b9c8e90008336d0f
😎 Deploy Preview https://deploy-preview-127--nextflow-training.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 settings.

@gitpod-io
Copy link

gitpod-io bot commented Jan 27, 2023

@netlify
Copy link

netlify bot commented Jan 27, 2023

Deploy Preview for nextflow-public-training ready!

Name Link
🔨 Latest commit bb0741b
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-public-training/deploys/63d9aa88d8d8d70008f7ec64
😎 Deploy Preview https://deploy-preview-127--nextflow-public-training.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 settings.

@ewels ewels marked this pull request as ready for review January 31, 2023 20:04
@ewels
Copy link
Member Author

ewels commented Feb 1, 2023

Approved on Seqera Slack in the #training channel ✅

@ewels ewels merged commit 2c5715c into nextflow-io:master Feb 1, 2023
@ewels ewels deleted the mkdocs branch February 1, 2023 12:05
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.

2 participants