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

Management documentation updates #2254

Merged
merged 24 commits into from
Oct 24, 2024

Conversation

craddm
Copy link
Contributor

@craddm craddm commented Oct 23, 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

⤴️ Summary

Updates various documentation sections to provide additional detail.

Specifically, it expands upon data egress/ingress procedures and tearing down of SHMs and SREs.

🌂 Related issues

Contributes to #2252
Closes #2146

🔬 Tests

Documentation only

Copy link

github-actions bot commented Oct 23, 2024

Coverage report

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

@craddm craddm marked this pull request as ready for review October 23, 2024 14:09
@craddm craddm requested a review from a team as a code owner October 23, 2024 14:09
@craddm craddm changed the title [WIP] Various documentation updates Various documentation updates Oct 23, 2024
@craddm craddm changed the title Various documentation updates Management documentation updates Oct 23, 2024
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.

This is looking good.

I think there are some changes we should make to keep it within scope and a few corrections.

docs/source/management/index.md Outdated Show resolved Hide resolved
docs/source/management/index.md Show resolved Hide resolved
docs/source/management/index.md Outdated Show resolved Hide resolved
docs/source/management/index.md Outdated Show resolved Hide resolved
docs/source/management/index.md Show resolved Hide resolved
docs/source/management/index.md Outdated Show resolved Hide resolved
docs/source/management/index.md Outdated Show resolved Hide resolved
docs/source/management/index.md Outdated Show resolved Hide resolved
docs/source/management/index.md Outdated Show resolved Hide resolved
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.

A few small suggestions but I think this is ready 👍

docs/source/management/index.md Outdated Show resolved Hide resolved
docs/source/management/index.md Outdated Show resolved Hide resolved
docs/source/management/index.md Outdated Show resolved Hide resolved
docs/source/management/index.md Outdated Show resolved Hide resolved
docs/source/management/index.md Outdated Show resolved Hide resolved
docs/source/management/index.md Outdated Show resolved Hide resolved
docs/source/management/index.md Outdated Show resolved Hide resolved
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.

LGTM 👍.

@craddm craddm merged commit 8a2fd5e into alan-turing-institute:release-v5.0.1rc1 Oct 24, 2024
11 checks passed
@craddm craddm deleted the doc-updates branch November 6, 2024 10:52
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