docs(deploy): standardize installation and uninstallation terminology in README files#168
Merged
WilliamBerryiii merged 4 commits intomainfrom Feb 12, 2026
Conversation
… in README files - update terminology for installation and uninstallation processes - clarify cleanup and destroy definitions - improve consistency in documentation language 📝 - Generated by Copilot
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
There was a problem hiding this comment.
Pull request overview
Standardizes deployment documentation terminology across deploy/ READMEs to distinguish deploy/setup/install/cleanup/uninstall/destroy and improve consistency in cleanup/destroy guidance.
Changes:
- Added a terminology glossary to
deploy/README.mdand updated cleanup/destroy wording to match the standardized terms. - Updated
deploy/002-setup/README.mdto use “cleanup” terminology while keeping script names (“uninstall-*”) accurate. - Updated
deploy/001-iac/README.mdwording to use “destroy” instead of “teardown” and adjusted prerequisite table column naming.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| deploy/README.md | Adds glossary and refines cleanup/destroy language in the top-level deployment guide. |
| deploy/002-setup/README.md | Renames uninstall-oriented descriptions/headings to cleanup terminology for consistency. |
| deploy/001-iac/README.md | Updates terminology (“destroy” vs “teardown”) and tweaks prerequisite wording. |
- clarify cleanup steps for cluster components - update descriptions for destroying infrastructure 🗑️ - Generated by Copilot
- specify order of destroying VPN and remaining infrastructure - improve instructions for resource group deletion 🔧 - Generated by Copilot
…description 🔒 - Generated by Copilot
nguyena2
deleted the
issue/95-docs-standardize-install-and-uninstall-conventions
branch
This was referenced Feb 10, 2026
This file contains hidden or 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
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.
Pull Request
Description
Standardize installation and uninstallation terminology across deploy README files for consistency.
Closes #95
Type of Change
Component(s) Affected
deploy/000-prerequisites- Azure subscription setupdeploy/001-iac- Terraform infrastructuredeploy/002-setup- OSMO control plane / Helmdeploy/004-workflow- Training workflowssrc/training- Python training scriptsdocs/- DocumentationTesting Performed
planreviewed (no unexpected changes)applytested in dev environmentsmoke_test_azure.py)Checklist