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

Update user guide #2130

Merged

Conversation

jemrobinson
Copy link
Member

@jemrobinson jemrobinson commented Aug 14, 2024

✅ Checklist

  • You have given your pull request a meaningful title (e.g. Enable foobar integration rather than 515 foobar).
  • You are targeting the appropriate branch. If you're not certain which one this is, it should be develop.
  • Your branch is up-to-date with the target branch (it probably was when you started, but it may have changed since then).

🚦 Depends on

n/a

⤴️ Summary

Full rewrite of the user guide to reflect changes made as part of v5 migration.

I've tried to use:

  • user: ada.lovelace
  • SHM: projects
  • SRE: sandbox
  • domain: projects.example.org

throughout, but let me know if I've missed anywhere.

Link to the preview build on readthedocs

🌂 Related issues

n/a

🔬 Tests

Documentation only

@jemrobinson jemrobinson requested review from a team as code owners August 14, 2024 12:05
@jemrobinson jemrobinson changed the base branch from develop to release-v5.0.0 August 14, 2024 12:05
Copy link

github-actions bot commented Aug 14, 2024

Coverage report

This PR does not seem to contain any modification to coverable code.

Copy link
Member

@JimMadge JimMadge left a 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.

docs/source/roles/researcher/troubleshooting.md Outdated Show resolved Hide resolved
docs/source/roles/researcher/troubleshooting.md Outdated Show resolved Hide resolved
docs/source/roles/researcher/using_the_sre.md Outdated Show resolved Hide resolved
docs/source/roles/researcher/using_the_sre.md Outdated Show resolved Hide resolved
docs/source/roles/researcher/using_the_sre.md Outdated Show resolved Hide resolved
docs/source/roles/researcher/using_the_sre.md Outdated Show resolved Hide resolved
docs/source/roles/researcher/using_the_sre.md Show resolved Hide resolved
Co-authored-by: Jim Madge <jim+github@jmadge.com>
@jemrobinson jemrobinson merged commit b5f3549 into alan-turing-institute:release-v5.0.0 Aug 14, 2024
11 checks passed
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