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.

Sign up for GitHub

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

Jump to bottom

Add instructions for upgrading scubagoggles #433

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

Add instructions for upgrading scubagoggles #433

wants to merge 5 commits into from

Conversation

adhilto
Copy link
Collaborator

@adhilto adhilto commented Sep 24, 2024

🗣 Description

Document how to upgrade ScubaGoggles (recreating #425; I tried to rebase on that branch but accidentally overwrote all my changes).

💭 Motivation and context

Closes #424.

🧪 Testing

Manually tested to determine easiest way to upgrade.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • If applicable, All future TODOs are captured in issues, which are referenced in the PR description.
  • The relevant issues PR resolves are linked preferably via closing keywords.
  • All relevant type-of-change labels have been added.
  • I have read and agree to the CONTRIBUTING.md document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated to reflect the changes in this PR.
  • Tests have been added and/or modified to cover the changes in this PR.
  • All new and existing tests pass.

✅ Pre-merge Checklist

  • This PR has been smoke tested to ensure main is in a functional state when this PR is merged.
  • Squash all commits into one PR level commit using the Squash and merge button.

✅ Post-merge Checklist

  • Delete the branch to clean up.
  • Close issues resolved by this PR if the closing keywords did not activate.

@adhilto adhilto added the documentation This issue or pull request improves or adds to documentation label Sep 24, 2024
@adhilto adhilto added this to the Coast milestone Sep 24, 2024
@adhilto adhilto self-assigned this Sep 24, 2024
@adhilto adhilto force-pushed the 424-add-instructions-for-upgrading-try-again branch from a251101 to 13fa122 Compare September 30, 2024 19:05
buidav
buidav requested changes Oct 1, 2024
View reviewed changes
docs/troubleshooting/Troubleshooting.md Outdated
Comment on lines 1 to 3
# Troubleshooting

## Upgrading ScubaGoggles
Copy link
Collaborator

Choose a reason for hiding this comment

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

This shouldn't be in the Troubleshooting section. Unless upgrading ScubaGoggles is troublesome :).

Perhaps another top level section called Upgrading and Maintaining ScubaGoggles would be a better fit?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good suggestion, added

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@buidav buidav buidav requested changes

@snarve snarve Awaiting requested review from snarve

Requested changes must be addressed to merge this pull request.

Assignees

@adhilto adhilto

Labels
documentation This issue or pull request improves or adds to documentation
Projects
None yet
Milestone
Coast
Development

Successfully merging this pull request may close these issues.

Add Instructions for upgrading ScubaGoggles
2 participants
@adhilto @buidav