-
Notifications
You must be signed in to change notification settings - Fork 15
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
Update user guide #2130
Merged
jemrobinson
merged 41 commits into
alan-turing-institute:release-v5.0.0
from
jemrobinson:update-user-guide
Aug 14, 2024
Merged
Update user guide #2130
jemrobinson
merged 41 commits into
alan-turing-institute:release-v5.0.0
from
jemrobinson:update-user-guide
Aug 14, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
JimMadge
requested changes
Aug 14, 2024
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.
Looks good. I've suggested a few changes.
I think getting the balance between what goes here and what belongs in another kind of documentation is difficult,
- Instance specific stuff like policies, processes
- How much to document about the tools we provide.
Co-authored-by: Jim Madge <jim+github@jmadge.com>
jemrobinson
commented
Aug 14, 2024
jemrobinson
commented
Aug 14, 2024
Co-authored-by: Jim Madge <jim+github@jmadge.com>
Co-authored-by: Jim Madge <jim+github@jmadge.com>
…tions to 'Using the SRE'
JimMadge
approved these changes
Aug 14, 2024
jemrobinson
merged commit Aug 14, 2024
b5f3549
into
alan-turing-institute:release-v5.0.0
11 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✅ Checklist
Enable foobar integration
rather than515 foobar
).develop
.🚦 Depends on
n/a
Full rewrite of the user guide to reflect changes made as part of v5 migration.
I've tried to use:
throughout, but let me know if I've missed anywhere.
Link to the preview build on readthedocs
🌂 Related issues
n/a
🔬 Tests
Documentation only