Proofread docs in the /operation directory #1710
Open
+210
−196
Conversation
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
teslazonda
changed the title
operation directory
teslazonda
changed the title
operation directory
teslazonda
commented
Nov 19, 2025
| recent Linux distributions. | ||
|
|
||
| For additional details you can refer to https://vyos.dev/T2490. | ||
| For details, see https://vyos.dev/T2490. |
Contributor
Author
There was a problem hiding this comment.
This issue was resolved in 2020. Is the above content still relevant?
teslazonda
commented
Nov 19, 2025
| .. note:: If a device is unplugged and re-plugged it will receive a new | ||
| Port, Dev, If identification. | ||
| .. note:: If a device is unplugged and plugged in again, it is assigned a new | ||
| ``Port``, ``Dev``, and ``If``. |
Contributor
Author
There was a problem hiding this comment.
What do Dev and If stand for?
teslazonda
commented
Nov 27, 2025
| ################# | ||
|
|
||
| Using the console, restart the VyOS router. The GRUB menu appears. | ||
| Select the relevant option from the GRUB menu and press Enter. |
Contributor
Author
There was a problem hiding this comment.
Is this password recovery flow still accurate?
sever-sever
reviewed
Nov 28, 2025
Copilot finished reviewing on behalf of
sever-sever
November 28, 2025 12:13
There was a problem hiding this comment.
Pull request overview
This PR proofreads and improves documentation in the /docs/operation directory to align with the Microsoft Writing Style Guide. The changes focus on improving clarity, consistency, and readability across five operation documentation files while updating the last proofread dates to November 2025.
- Standardized UI element formatting using bold text (e.g., Yes, No, Enter)
- Improved sentence structure and readability throughout the documentation
- Updated terminology for consistency (e.g., "RAID-1" to "RAID 1")
- Enhanced descriptions with clearer, more concise language
- Added proper section cross-references and updated metadata
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
docs/operation/upgrade-recovery.rst |
Improved readability of upgrade recovery feature documentation, clarified timeout behavior, and wrapped long lines for better formatting |
docs/operation/raid.rst |
Extensive revisions to RAID 1 documentation including terminology standardization, UI element formatting, section header updates, and improved procedural instructions |
docs/operation/password-recovery.rst |
Minor improvements to password recovery instructions with updated UI element formatting and clearer action descriptions |
docs/operation/information.rst |
Enhanced system information command documentation with updated examples, improved USB device descriptions, and added VyOS 1.5 release train information |
docs/operation/boot-options.rst |
Simplified boot option instructions with clearer warnings and more concise procedural steps |
docs/_locale/{uk,pt,ja,es,de}/operation.pot |
Updated translation files to reflect changes in UI element formatting from quoted text to bold text |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Change Summary
Edited content in the
docs/operationdirectory to align with the Microsoft Writing Style Guideboot-options.rstinformation.rstupgrade-recovery.rstraid.rstpassword-recovery.rstRelated Task(s)
Related PR(s)
Backport
Checklist: