-
Notifications
You must be signed in to change notification settings - Fork 196
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
base: main
Are you sure you want to change the base?
Conversation
christopher-hakkaart
commented
Aug 9, 2024
- Reshuffles usage sections
- Improves install guide
- Added more configuration explanation
- Reshuffled configuration pages to make them shorter
- Removed extra text that was repeated
Signed-off-by: christopher-hakkaart <[email protected]>
✅ Deploy Preview for nf-core-main-site ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
sites/docs/src/content/docs/usage/configuration/runningoffline.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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/main-site/src/content/special-interest-groups/regulatory/meetings.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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...
sites/docs/src/content/docs/usage/configuration/system_requirements.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/system_requirements.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/system_requirements.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/system_requirements.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/system_requirements.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/system_requirements.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/system_requirements.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/system_requirements.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/system_requirements.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/system_requirements.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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
sites/docs/src/content/docs/usage/configuration/modify_tools.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/modify_tools.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/modify_tools.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/modify_tools.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/modify_tools.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/modify_tools.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/modify_tools.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/modify_tools.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/modify_tools.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/modify_tools.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/running_offline.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And offline...
sites/docs/src/content/docs/usage/configuration/running_offline.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/running_offline.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/running_offline.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/running_offline.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/running_offline.md
Outdated
Show resolved
Hide resolved
sites/docs/src/content/docs/usage/configuration/running_offline.md
Outdated
Show resolved
Hide resolved
Co-authored-by: James A. Fellows Yates <[email protected]>
Merge suggestions from James Co-authored-by: James A. Fellows Yates <[email protected]>
Co-authored-by: James A. Fellows Yates <[email protected]>
…to install-guide
{ | ||
type: 'group', | ||
id: 'guides', | ||
label: 'Guides', |
There was a problem hiding this comment.
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 ?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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..