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

Improve install, usage, and configuration guide #2677

Open
wants to merge 30 commits into
base: main
Choose a base branch
from

Conversation

christopher-hakkaart
Copy link
Member

  • Reshuffles usage sections
  • Improves install guide
  • Added more configuration explanation
  • Reshuffled configuration pages to make them shorter
  • Removed extra text that was repeated

Copy link

netlify bot commented Aug 9, 2024

Deploy Preview for nf-core-main-site ready!

Name Link
🔨 Latest commit 1d374e3
🔍 Latest deploy log https://app.netlify.com/sites/nf-core-main-site/deploys/66e27be36bab420008a72971
😎 Deploy Preview https://deploy-preview-2677--nf-core-main-site.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

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

First set of comments on the main quick_start introduction (ran out of time, will come back to the rest later)

sites/docs/src/content/docs/guidelines/terminology.md Outdated Show resolved Hide resolved
jfy133

This comment was marked as resolved.

Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

Comments on system requirements...

Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

Comments on modify_tools

Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

And offline...

Merge suggestions from James

Co-authored-by: James A. Fellows Yates <[email protected]>
Co-authored-by: James A. Fellows Yates <[email protected]>
{
type: 'group',
id: 'guides',
label: 'Guides',
Copy link
Member

Choose a reason for hiding this comment

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

I don't get it - the PR preview still shows this as Guides I think..? In fact it looks exactly like the live site as far as I can tell. Is the preview rendering correctly @christopher-hakkaart ?

Copy link
Member Author

Choose a reason for hiding this comment

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

It shows locally - I'll look into it

Copy link
Member

Choose a reason for hiding this comment

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

I guess this is similar issues to what we've seen elsewhere with deployment previews after the new multi-site split thing.

I think we may need to write some custom GitHub actions code to generate previews..

@christopher-hakkaart christopher-hakkaart marked this pull request as ready for review September 12, 2024 05:28
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.

4 participants