From eeed7e82b051db6cf5aafee8f4b772d6a8f4be40 Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Thu, 13 Nov 2025 22:31:09 +0900 Subject: [PATCH 01/15] Proofread boot-options.rst --- docs/operation/boot-options.rst | 29 +++++++++++++---------------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/docs/operation/boot-options.rst b/docs/operation/boot-options.rst index 70cdc418d7..b2cebbb5ce 100644 --- a/docs/operation/boot-options.rst +++ b/docs/operation/boot-options.rst @@ -1,3 +1,5 @@ +:lastproofread: 2025-11-14 + .. _boot-options: @@ -5,17 +7,13 @@ Boot Options ############ -.. warning:: This function may be highly disruptive. - It may cause major service interruption, so make sure you really - need it and verify your input carefully. - +.. warning:: This function can disrupt services. + Run it only when necessary, and verify all input values before proceeding. -VyOS has several kernel command line options to modify the normal boot -process. -To add an option, select the desired image in GRUB menu at load -time, press **e**, edit the first line, and press **Ctrl-x** to boot when -ready. +VyOS provides several kernel command-line options to modify the normal boot process. +To add an option, select the desired image in the GRUB menu at load time. +Press **e** to edit the first line, and then press **Ctrl+x** to boot. .. image:: /_static/images/boot-options.png :width: 80% @@ -25,16 +23,15 @@ ready. Specify custom config file ========================== -Tells the system to use specified file instead of ``/config/config.boot``. -If specified file does not exist or is not readable, fall back to -default config. No additional verification is performed, so make sure -you specify a valid config file. +You can use a configuration file instead of the default ``/config/config.boot`` file. +If the specified file doesn't exist or isn't readable, the system uses the default configuration file. +No additional verification is performed, so specify a valid configuration file. .. code-block:: none vyos-config=/path/to/file -To load the *factory default* config, use: +To load the *factory default* configuration, use: .. code-block:: none @@ -44,8 +41,8 @@ To load the *factory default* config, use: Disable specific boot process steps =================================== -These options disable some boot steps. Make sure you understand the -:ref:`boot process ` well before using them! +These options disable certain steps in the boot process. Understand the +:ref:`boot process ` before using them. .. glossary:: From 4d123fd6c033436d9e1a9ed7fccd573703db158f Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Fri, 14 Nov 2025 13:58:01 +0900 Subject: [PATCH 02/15] Fix line length Markdown lint errors --- docs/operation/boot-options.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/operation/boot-options.rst b/docs/operation/boot-options.rst index b2cebbb5ce..67654b1ab4 100644 --- a/docs/operation/boot-options.rst +++ b/docs/operation/boot-options.rst @@ -11,9 +11,10 @@ Boot Options Run it only when necessary, and verify all input values before proceeding. -VyOS provides several kernel command-line options to modify the normal boot process. +VyOS provides several kernel command-line options to modify the normal boot +process. To add an option, select the desired image in the GRUB menu at load time. -Press **e** to edit the first line, and then press **Ctrl+x** to boot. +Type **e** to edit the first line, then type **Ctrl+x** to boot. .. image:: /_static/images/boot-options.png :width: 80% @@ -23,8 +24,10 @@ Press **e** to edit the first line, and then press **Ctrl+x** to boot. Specify custom config file ========================== -You can use a configuration file instead of the default ``/config/config.boot`` file. -If the specified file doesn't exist or isn't readable, the system uses the default configuration file. +You can use a configuration file instead of the default ``/config/config.boot`` +file. +If the specified file doesn't exist or isn't readable, the system uses the +default configuration file. No additional verification is performed, so specify a valid configuration file. .. code-block:: none From 60be5b9c5da6f89c8e7e82007f2776a57cff627f Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Wed, 19 Nov 2025 20:52:01 +0900 Subject: [PATCH 03/15] Proofread information.rst --- docs/operation/information.rst | 51 ++++++++++++++++++---------------- 1 file changed, 27 insertions(+), 24 deletions(-) diff --git a/docs/operation/information.rst b/docs/operation/information.rst index e32e55b4a0..0a84714572 100644 --- a/docs/operation/information.rst +++ b/docs/operation/information.rst @@ -3,11 +3,12 @@ .. _information: *********** -Information +System Information *********** VyOS features a rich set of operational level commands to retrieve arbitrary -information about your running system. +information about your running system. For more information on the VyOS command +line interface (CLI), see :ref:`cli`. ######## Hardware @@ -18,27 +19,29 @@ Hardware USB === -In the past serial interface have been defined as ttySx and ttyUSBx where x was -an instance number of the serial interface. It was discovered that from system -boot to system boot the mapping of USB based serial interfaces will differ, -depending which driver was loaded first by the operating system. This will -become rather painful if you not only have serial interfaces for a console -server connected but in addition also a serial backed :ref:`wwan-interface`. +In the past, serial interfaces were defined as ``ttySx`` and ``ttyUSBx`` where +``x`` +was the instance number. However, the mapping of USB-based serial interfaces +can change from one system boot to another, depending on which driver the +operating system loads first. This inconsistency can be problematic when you +use multiple serial interfaces. +For example, both console-server connections and a serial-backed +:ref:`wwan-interface`. -To overcome this issue and the fact that in almost 50% of all cheap USB to -serial converters there is no serial number programmed, the USB to serial -interface is now directly identified by the USB root bridge and bus it connects -to. This somehow mimics the new network interface definitions we see in recent -Linux distributions. +To address this issue, and because of many low-cost USB-to-serial converters +do not have a programmed serial number, VyOS now identifies USB-to-serial +interfaces by the USB root bridge and the bus they connect to. +This approach is similar to the network interface naming conventions used in +recent Linux distributions. -For additional details you can refer to https://vyos.dev/T2490. +For details, see https://vyos.dev/T2490. .. opcmd:: show hardware usb - Retrieve a tree like representation of all connected USB devices. + Retrieve a tree-like representation of all connected USB devices. - .. 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``. .. code-block:: none @@ -72,8 +75,8 @@ For additional details you can refer to https://vyos.dev/T2490. .. opcmd:: show hardware usb serial Retrieve a list and description of all connected USB serial devices. The - device name displayed, e.g. `usb0b2.4p1.0` can be directly used when accessing - the serial console as console-server device. + device name displayed, (for example ``usb0b2.4p1.0``), can be used + directly when accessing the serial console as console-server device. .. code-block:: none @@ -105,9 +108,9 @@ Version .. opcmd:: show version - Return the current running VyOS version and build information. This includes - also the name of the release train which is ``crux`` on VyOS 1.2, ``equuleus`` - on VyOS 1.3 and ``sagitta`` on VyOS 1.4. + Return the currently running VyOS version and build information. This includes + the name of the release train, which is ``crux`` on VyOS 1.2, ``equuleus`` + on VyOS 1.3, ``sagitta`` on VyOS 1.4, and ``circinus`` on VyOS 1.5. .. code-block:: none @@ -134,7 +137,7 @@ Version .. opcmd:: show version kernel - Return version number of the Linux Kernel used in this release. + Return the version number of the currently running Linux kernel. .. code-block:: none @@ -143,7 +146,7 @@ Version .. opcmd:: show version frr - Return version number of FRR (Free Range Routing - https://frrouting.org/) + Return the version number of FRR (Free Range Routing - https://frrouting.org/) used in this release. This is the routing control plane and a successor to GNU Zebra and Quagga. From af8b272590d99dea2703c313c62b0cd9269f86db Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Wed, 19 Nov 2025 20:57:02 +0900 Subject: [PATCH 04/15] Update lastproofread date in information.rst --- docs/operation/information.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/operation/information.rst b/docs/operation/information.rst index 0a84714572..7b541bc9c0 100644 --- a/docs/operation/information.rst +++ b/docs/operation/information.rst @@ -1,4 +1,4 @@ -:lastproofread: 2021-07-07 +:lastproofread: 2025-11-19 .. _information: From 99752f4f9701eb81818f6135e67b0e3aaee6b5fd Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Wed, 19 Nov 2025 22:47:32 +0900 Subject: [PATCH 05/15] Updated password-recovery.rst --- docs/operation/password-recovery.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/operation/password-recovery.rst b/docs/operation/password-recovery.rst index 59f4d7c9d9..e0c4fda58c 100755 --- a/docs/operation/password-recovery.rst +++ b/docs/operation/password-recovery.rst @@ -1,3 +1,5 @@ +:lastproofread: 2025-11-19 + .. _password-recovery: ################# @@ -5,14 +7,14 @@ Password Recovery ################# Using the console, restart the VyOS router. The GRUB menu appears. -Select the relevant option from the GRUB menu and press Enter. -The option must start with “Lost password change.” +Select the relevant option from the GRUB menu, then press **Enter**. +The option must begin with *Lost password change.* .. figure:: /_static/images/password-recovery-01.png :width: 600 -The stand-alone user-password recovery tool starts running and prompts -you to reset the local system user password. +The stand-alone user-password recovery tool runs and prompts you to reset the +local system user password. .. code-block:: console From f642b7f5ea55ba1881b14293c129dbb30127539f Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Thu, 20 Nov 2025 22:02:42 +0900 Subject: [PATCH 06/15] Proofread upgrade-recovery.rst --- docs/operation/upgrade-recovery.rst | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/operation/upgrade-recovery.rst b/docs/operation/upgrade-recovery.rst index e39d7e0d9d..66b00b3e7d 100644 --- a/docs/operation/upgrade-recovery.rst +++ b/docs/operation/upgrade-recovery.rst @@ -1,3 +1,5 @@ +:lastproofread: 2025-11-20 + .. _upgrade_recovery: @@ -5,20 +7,21 @@ Recovery after Failed Upgrades ############################## -This section explains **VyOS’s upgrade recovery**, which restores the system to the last working version after a failed upgrade. It covers the following points: +Use **VyOS upgrade recovery** to restore the system to the last working +version after a failed upgrade. * :ref:`Configuration: ` How to enable upgrade recovery * :ref:`How it Works: ` Overview of the recovery process -* :ref:`Cancelling Recovery: ` Overview of the recovery process +* :ref:`Cancelling Recovery: ` Overview of the recovery + process - - .. _configuration: ************* Configuration ************* -.. warning:: Upgrade recovery is disabled by default. To use it, **enable it first**. +.. warning:: Upgrade recovery is disabled by default. To use it, +**enable it first**. To enable upgrade recovery, run the following command: @@ -26,7 +29,7 @@ To enable upgrade recovery, run the following command: set system option reboot-on-upgrade-failure [timeout ] -* ``timeout :`` The time in minutes (from 5 to 30) you have to cancel upgrade recovery. See :ref:`Cancelling Recovery `. +* ``timeout :`` The time in minutes (5 - 30) you have to cancel upgrade recovery. See :ref:`Cancelling Recovery `. .. _how_it_works: From 75908d2fead640ba09e36aec79656a0fb502ac7e Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Thu, 20 Nov 2025 22:06:48 +0900 Subject: [PATCH 07/15] Fix line length linting errors --- docs/operation/upgrade-recovery.rst | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/operation/upgrade-recovery.rst b/docs/operation/upgrade-recovery.rst index 66b00b3e7d..cec0211011 100644 --- a/docs/operation/upgrade-recovery.rst +++ b/docs/operation/upgrade-recovery.rst @@ -13,7 +13,7 @@ version after a failed upgrade. * :ref:`Configuration: ` How to enable upgrade recovery * :ref:`How it Works: ` Overview of the recovery process * :ref:`Cancelling Recovery: ` Overview of the recovery - process + process .. _configuration: @@ -21,7 +21,7 @@ version after a failed upgrade. Configuration ************* .. warning:: Upgrade recovery is disabled by default. To use it, -**enable it first**. + **enable it first**. To enable upgrade recovery, run the following command: @@ -29,14 +29,17 @@ To enable upgrade recovery, run the following command: set system option reboot-on-upgrade-failure [timeout ] -* ``timeout :`` The time in minutes (5 - 30) you have to cancel upgrade recovery. See :ref:`Cancelling Recovery `. +* ``timeout :`` The time in minutes (5 - 30) you have to cancel upgrade + recovery. See :ref:`Cancelling Recovery `. .. _how_it_works: ************ How it Works ************ -After a VyOS upgrade, the system monitors the boot process. Upon detecting a boot failure, VyOS initiates a revert to the last working version and displays the following warning: +After a VyOS upgrade, the system monitors the boot process. Upon detecting a +boot failure, VyOS initiates a revert to the last working version and displays +the following warning: .. code-block:: none @@ -44,7 +47,8 @@ After a VyOS upgrade, the system monitors the boot process. Upon detecting a boo Automatic reboot in xx minutes Use "reboot cancel" to cancel -If no action is taken, the reboot happens automatically after the configured timeout. Upon successful recovery and reboot, the following message appears: +If no action is taken, the reboot happens automatically after the configured +timeout. Upon successful recovery and reboot, the following message appears: .. code-block:: none @@ -58,7 +62,9 @@ If no action is taken, the reboot happens automatically after the configured tim ******************* Cancelling Recovery ******************* -Upon detecting a boot failure, you have the predefined timeout to cancel upgrade recovery. This is useful if you want to troubleshoot the faulty VyOS version on your own. +Upon detecting a boot failure, you have the predefined timeout to cancel +upgrade recovery. This is useful if you want to troubleshoot the faulty VyOS +version on your own. To cancel upgrade recovery, run the following command: From fa666f4e22f867ff4bf1ab77a69597cff6d6fbb4 Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Fri, 21 Nov 2025 17:08:54 +0900 Subject: [PATCH 08/15] Proofread up to Empty 2+ Disk --- docs/operation/raid.rst | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/docs/operation/raid.rst b/docs/operation/raid.rst index 642a733280..2c835faf1a 100644 --- a/docs/operation/raid.rst +++ b/docs/operation/raid.rst @@ -1,3 +1,5 @@ +:lastproofread: 2025-11-20 + .. _raid: ###### @@ -7,37 +9,37 @@ RAID-1 A Redundant Array of Independent Disks (RAID) uses two or more hard disk drives to improve disk speed, store more data, and/or provide fault tolerance. There are several storage schemes possible in a RAID array, each offering a -different combination of storage, reliability, and/or performance. -The VyOS system supports a “RAID 1” deployment. RAID 1 allows two or more -disks to mirror one another to provide system fault tolerance. In a RAID 1 -solution, every sector of one disk is duplicated onto every sector of all +different combination of storage, reliability, and performance. +VyOS supports **RAID 1** deployments. RAID 1 uses two or more +disks that mirror one another to provide system fault tolerance. In a RAID 1 +configuration, every sector on one disk is duplicated on every sector of all disks in the array. Provided even one disk in the RAID 1 set is operational, the system continues to run, even through disk replacement (provided that the hardware supports in-service replacement of drives). RAID 1 can be implemented using special hardware or it can be implemented in -software. The VyOS system supports software RAID 1 on two disks. -The VyOS implementation of RAID 1 allows the following: +software. VyOS supports software RAID 1 on two disks. +The VyOS implementation of RAID 1 features the following: -* Detection and reporting of disk failure -* The ability to maintain system operation with one failed disk -* The ability to boot the system with one failed disk -* The ability to replace a failed disk and initiate re-mirroring -* The ability to monitor the status of remirroring +* Detection and reporting of disk failure. +* Maintain system operation with one failed disk. +* Boot the system with one failed disk. +* Replace a failed disk and initiate re-mirroring. +* Monitor the status of re-mirroring. .. _raid_installation: Installation Implications ========================= -The VyOS systems installation utility provides several options for installing +The VyOS installation utility provides several options for installing to a RAID 1 set. You can: * Use the install system to create the RAID 1 set -* Use the underlying Linux commands to create a RAID 1 set before running the +* Use the built-in Linux commands to create a RAID 1 set before running the install system command. * Use a previously-created RAID 1 set. -.. note:: Before a permanent installation, VyOS runs a live installation +.. note:: Before a permanent installation, VyOS runs a live installation. Configuration ============= @@ -45,17 +47,16 @@ Configuration Single disk, install as normal ------------------------------ -When the VyOS system is installed, it automatically detects the presence of two -disks not currently part of a RAID array. In these cases, the VyOS -installation utility automatically offers you the option of configuring RAID 1 -mirroring for the drives, with the following prompt. +VyOS automatically detects the presence of two or more +disks that are not currently part of a RAID array when installed. The VyOS +installation utility automatically offers you the option to configure RAID 1 +mirroring for eligible drives with the following prompt: .. code-block:: none Would you like to configure RAID 1 mirroring on them? -* If you do not want to configure RAID 1 mirroring, enter “No” at the prompt - and continue with installation in the normal way. +* If you do not want to configure RAID 1 mirroring, enter **No** at the prompt. Empty 2+ Disk ------------- From d3c88bd20e78ef759e389dd66c20b4c13ee40b37 Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Tue, 25 Nov 2025 10:47:26 +0900 Subject: [PATCH 09/15] Complete proofread of raid.rst --- docs/_locale/de/operation.pot | 28 ++++---- docs/_locale/es/operation.pot | 14 ++-- docs/_locale/ja/operation.pot | 28 ++++---- docs/_locale/pt/operation.pot | 28 ++++---- docs/_locale/uk/operation.pot | 14 ++-- docs/operation/raid.rst | 117 +++++++++++++++++----------------- 6 files changed, 114 insertions(+), 115 deletions(-) diff --git a/docs/_locale/de/operation.pot b/docs/_locale/de/operation.pot index 575bbd2992..4faf79989a 100644 --- a/docs/_locale/de/operation.pot +++ b/docs/_locale/de/operation.pot @@ -13,24 +13,24 @@ msgid "1 - Remove the failed disk from the RAID 1 set by issuing the following c msgstr "1 - Remove the failed disk from the RAID 1 set by issuing the following command:" #: ../../operation/raid.rst:113 -msgid "1 - To break apart the current RAID 1 set, enter “No” at the prompt. The" -msgstr "1 - To break apart the current RAID 1 set, enter “No” at the prompt. The" +msgid "1 - To break apart the current RAID 1 set, enter **No** at the prompt. The" +msgstr "1 - To break apart the current RAID 1 set, enter **No** at the prompt. The" #: ../../operation/raid.rst:71 -msgid "1 - To create a new RAID 1 array, enter “Yes” at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." -msgstr "1 - To create a new RAID 1 array, enter “Yes” at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." +msgid "1 - To create a new RAID 1 array, enter **Yes** at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." +msgstr "1 - To create a new RAID 1 array, enter **Yes** at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." #: ../../operation/raid.rst:162 msgid "2- Physically remove the failed disk from the system. If the drives are not hot-swappable, then you must shut down the system before removing the disk." msgstr "2- Physically remove the failed disk from the system. If the drives are not hot-swappable, then you must shut down the system before removing the disk." #: ../../operation/raid.rst:123 -msgid "2 - To decline to set up a new RAID 1 configuration on the disks, enter “No” at the prompt. The system prompts you to indicate which partition you would like the system installed on." -msgstr "2 - To decline to set up a new RAID 1 configuration on the disks, enter “No” at the prompt. The system prompts you to indicate which partition you would like the system installed on." +msgid "2 - To decline to set up a new RAID 1 configuration on the disks, enter **No** at the prompt. The system prompts you to indicate which partition you would like the system installed on." +msgstr "2 - To decline to set up a new RAID 1 configuration on the disks, enter **No** at the prompt. The system prompts you to indicate which partition you would like the system installed on." #: ../../operation/raid.rst:79 -msgid "2 - To overwrite the old filesystem, enter “Yes”." -msgstr "2 - To overwrite the old filesystem, enter “Yes”." +msgid "2 - To overwrite the old filesystem, enter **Yes**." +msgstr "2 - To overwrite the old filesystem, enter **Yes**." #: ../../operation/raid.rst:131 msgid "3 - Enter the partition where you would like the system installed. The system then prompts you to indicate whether you want to save the old configuration data. This represents the current VyOS configuration." @@ -46,8 +46,8 @@ msgstr "3 - The system informs you that all data on both drives will be erased. #: ../../operation/raid.rst:88 #: ../../operation/raid.rst:139 -msgid "4 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." -msgstr "4 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." +msgid "4 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." +msgstr "4 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." #: ../../operation/raid.rst:167 msgid "4 - Format the new disk for RAID 1 by issuing the following command:" @@ -62,8 +62,8 @@ msgid "5 - Continue with installation in the normal way." msgstr "5 - Continue with installation in the normal way." #: ../../operation/raid.rst:96 -msgid "5 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." -msgstr "5 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." +msgid "5 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." +msgstr "5 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." #: ../../operation/raid.rst:99 msgid "6 - Continue with installation in the normal way." @@ -126,8 +126,8 @@ msgid "If a device is unplugged and re-plugged it will receive a new Port, Dev, msgstr "If a device is unplugged and re-plugged it will receive a new Port, Dev, If identification." #: ../../operation/raid.rst:57 -msgid "If you do not want to configure RAID 1 mirroring, enter “No” at the prompt and continue with installation in the normal way." -msgstr "If you do not want to configure RAID 1 mirroring, enter “No” at the prompt and continue with installation in the normal way." +msgid "If you do not want to configure RAID 1 mirroring, enter **No** at the prompt and continue with installation in the normal way." +msgstr "If you do not want to configure RAID 1 mirroring, enter **No** at the prompt and continue with installation in the normal way." #: ../../operation/information.rst:21 msgid "In the past serial interface have been defined as ttySx and ttyUSBx where x was an instance number of the serial interface. It was discovered that from system boot to system boot the mapping of USB based serial interfaces will differ, depending which driver was loaded first by the operating system. This will become rather painful if you not only have serial interfaces for a console server connected but in addition also a serial backed :ref:`wwan-interface`." diff --git a/docs/_locale/es/operation.pot b/docs/_locale/es/operation.pot index 585ebd6f36..75f059cbb5 100644 --- a/docs/_locale/es/operation.pot +++ b/docs/_locale/es/operation.pot @@ -13,11 +13,11 @@ msgid "1 - Remove the failed disk from the RAID 1 set by issuing the following c msgstr "1: elimine el disco fallido del conjunto RAID 1 emitiendo el siguiente comando:" #: ../../operation/raid.rst:113 -msgid "1 - To break apart the current RAID 1 set, enter “No” at the prompt. The" +msgid "1 - To break apart the current RAID 1 set, enter **No** at the prompt. The" msgstr "1 - Para dividir el conjunto RAID 1 actual, ingrese "No" en el indicador. El" #: ../../operation/raid.rst:71 -msgid "1 - To create a new RAID 1 array, enter “Yes” at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." +msgid "1 - To create a new RAID 1 array, enter **Yes** at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." msgstr "1 - Para crear una nueva matriz RAID 1, ingrese "Sí" en el indicador. Si el sistema detecta un sistema de archivos en las particiones que se utilizan para RAID 1, le pedirá que indique si desea continuar creando la matriz RAID 1." #: ../../operation/raid.rst:162 @@ -25,11 +25,11 @@ msgid "2- Physically remove the failed disk from the system. If the drives are n msgstr "2- Retire físicamente el disco fallido del sistema. Si las unidades no son intercambiables en caliente, debe apagar el sistema antes de extraer el disco." #: ../../operation/raid.rst:123 -msgid "2 - To decline to set up a new RAID 1 configuration on the disks, enter “No” at the prompt. The system prompts you to indicate which partition you would like the system installed on." +msgid "2 - To decline to set up a new RAID 1 configuration on the disks, enter **No** at the prompt. The system prompts you to indicate which partition you would like the system installed on." msgstr "2 - Para negarse a establecer una nueva configuración RAID 1 en los discos, ingrese "No" en el indicador. El sistema le solicita que indique en qué partición desea instalar el sistema." #: ../../operation/raid.rst:79 -msgid "2 - To overwrite the old filesystem, enter “Yes”." +msgid "2 - To overwrite the old filesystem, enter **Yes**." msgstr "2 - Para sobrescribir el antiguo sistema de archivos, ingrese "Sí"." #: ../../operation/raid.rst:131 @@ -46,7 +46,7 @@ msgstr "3 - El sistema le informa que se borrarán todos los datos de ambas unid #: ../../operation/raid.rst:88 #: ../../operation/raid.rst:139 -msgid "4 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." +msgid "4 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." msgstr "4 - Ingrese "Sí" en el mensaje para conservar la configuración actual de VyOS una vez que se complete la instalación. Ingrese "No" para eliminar la configuración actual de VyOS." #: ../../operation/raid.rst:167 @@ -62,7 +62,7 @@ msgid "5 - Continue with installation in the normal way." msgstr "5 - Continuar con la instalación de forma normal." #: ../../operation/raid.rst:96 -msgid "5 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." +msgid "5 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." msgstr "5 - Ingrese "Sí" en el mensaje para conservar la configuración actual de VyOS una vez que se complete la instalación. Ingrese "No" para eliminar la configuración actual de VyOS." #: ../../operation/raid.rst:99 @@ -126,7 +126,7 @@ msgid "If a device is unplugged and re-plugged it will receive a new Port, Dev, msgstr "Si un dispositivo se desenchufa y se vuelve a enchufar, recibirá una nueva identificación de Puerto, Dev, If." #: ../../operation/raid.rst:57 -msgid "If you do not want to configure RAID 1 mirroring, enter “No” at the prompt and continue with installation in the normal way." +msgid "If you do not want to configure RAID 1 mirroring, enter **No** at the prompt and continue with installation in the normal way." msgstr "Si no desea configurar la duplicación de RAID 1, ingrese "No" en el indicador y continúe con la instalación de la manera normal." #: ../../operation/information.rst:21 diff --git a/docs/_locale/ja/operation.pot b/docs/_locale/ja/operation.pot index 0a11547c03..5a203cb1da 100644 --- a/docs/_locale/ja/operation.pot +++ b/docs/_locale/ja/operation.pot @@ -13,24 +13,24 @@ msgid "1 - Remove the failed disk from the RAID 1 set by issuing the following c msgstr "1 - Remove the failed disk from the RAID 1 set by issuing the following command:" #: ../../operation/raid.rst:113 -msgid "1 - To break apart the current RAID 1 set, enter “No” at the prompt. The" -msgstr "1 - To break apart the current RAID 1 set, enter “No” at the prompt. The" +msgid "1 - To break apart the current RAID 1 set, enter **No** at the prompt. The" +msgstr "1 - To break apart the current RAID 1 set, enter **No** at the prompt. The" #: ../../operation/raid.rst:71 -msgid "1 - To create a new RAID 1 array, enter “Yes” at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." -msgstr "1 - To create a new RAID 1 array, enter “Yes” at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." +msgid "1 - To create a new RAID 1 array, enter **Yes** at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." +msgstr "1 - To create a new RAID 1 array, enter **Yes** at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." #: ../../operation/raid.rst:162 msgid "2- Physically remove the failed disk from the system. If the drives are not hot-swappable, then you must shut down the system before removing the disk." msgstr "2- Physically remove the failed disk from the system. If the drives are not hot-swappable, then you must shut down the system before removing the disk." #: ../../operation/raid.rst:123 -msgid "2 - To decline to set up a new RAID 1 configuration on the disks, enter “No” at the prompt. The system prompts you to indicate which partition you would like the system installed on." -msgstr "2 - To decline to set up a new RAID 1 configuration on the disks, enter “No” at the prompt. The system prompts you to indicate which partition you would like the system installed on." +msgid "2 - To decline to set up a new RAID 1 configuration on the disks, enter **No** at the prompt. The system prompts you to indicate which partition you would like the system installed on." +msgstr "2 - To decline to set up a new RAID 1 configuration on the disks, enter **No** at the prompt. The system prompts you to indicate which partition you would like the system installed on." #: ../../operation/raid.rst:79 -msgid "2 - To overwrite the old filesystem, enter “Yes”." -msgstr "2 - To overwrite the old filesystem, enter “Yes”." +msgid "2 - To overwrite the old filesystem, enter **Yes**." +msgstr "2 - To overwrite the old filesystem, enter **Yes**." #: ../../operation/raid.rst:131 msgid "3 - Enter the partition where you would like the system installed. The system then prompts you to indicate whether you want to save the old configuration data. This represents the current VyOS configuration." @@ -46,8 +46,8 @@ msgstr "3 - The system informs you that all data on both drives will be erased. #: ../../operation/raid.rst:88 #: ../../operation/raid.rst:139 -msgid "4 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." -msgstr "4 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." +msgid "4 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." +msgstr "4 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." #: ../../operation/raid.rst:167 msgid "4 - Format the new disk for RAID 1 by issuing the following command:" @@ -62,8 +62,8 @@ msgid "5 - Continue with installation in the normal way." msgstr "5 - Continue with installation in the normal way." #: ../../operation/raid.rst:96 -msgid "5 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." -msgstr "5 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." +msgid "5 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." +msgstr "5 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." #: ../../operation/raid.rst:99 msgid "6 - Continue with installation in the normal way." @@ -126,8 +126,8 @@ msgid "If a device is unplugged and re-plugged it will receive a new Port, Dev, msgstr "If a device is unplugged and re-plugged it will receive a new Port, Dev, If identification." #: ../../operation/raid.rst:57 -msgid "If you do not want to configure RAID 1 mirroring, enter “No” at the prompt and continue with installation in the normal way." -msgstr "If you do not want to configure RAID 1 mirroring, enter “No” at the prompt and continue with installation in the normal way." +msgid "If you do not want to configure RAID 1 mirroring, enter **No** at the prompt and continue with installation in the normal way." +msgstr "If you do not want to configure RAID 1 mirroring, enter **No** at the prompt and continue with installation in the normal way." #: ../../operation/information.rst:21 msgid "In the past serial interface have been defined as ttySx and ttyUSBx where x was an instance number of the serial interface. It was discovered that from system boot to system boot the mapping of USB based serial interfaces will differ, depending which driver was loaded first by the operating system. This will become rather painful if you not only have serial interfaces for a console server connected but in addition also a serial backed :ref:`wwan-interface`." diff --git a/docs/_locale/pt/operation.pot b/docs/_locale/pt/operation.pot index eaa518dcef..e921d15d0e 100644 --- a/docs/_locale/pt/operation.pot +++ b/docs/_locale/pt/operation.pot @@ -13,24 +13,24 @@ msgid "1 - Remove the failed disk from the RAID 1 set by issuing the following c msgstr "1 - Remove the failed disk from the RAID 1 set by issuing the following command:" #: ../../operation/raid.rst:113 -msgid "1 - To break apart the current RAID 1 set, enter “No” at the prompt. The" -msgstr "1 - To break apart the current RAID 1 set, enter “No” at the prompt. The" +msgid "1 - To break apart the current RAID 1 set, enter **No** at the prompt. The" +msgstr "1 - To break apart the current RAID 1 set, enter **No** at the prompt. The" #: ../../operation/raid.rst:71 -msgid "1 - To create a new RAID 1 array, enter “Yes” at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." -msgstr "1 - To create a new RAID 1 array, enter “Yes” at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." +msgid "1 - To create a new RAID 1 array, enter **Yes** at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." +msgstr "1 - To create a new RAID 1 array, enter **Yes** at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." #: ../../operation/raid.rst:162 msgid "2- Physically remove the failed disk from the system. If the drives are not hot-swappable, then you must shut down the system before removing the disk." msgstr "2- Physically remove the failed disk from the system. If the drives are not hot-swappable, then you must shut down the system before removing the disk." #: ../../operation/raid.rst:123 -msgid "2 - To decline to set up a new RAID 1 configuration on the disks, enter “No” at the prompt. The system prompts you to indicate which partition you would like the system installed on." -msgstr "2 - To decline to set up a new RAID 1 configuration on the disks, enter “No” at the prompt. The system prompts you to indicate which partition you would like the system installed on." +msgid "2 - To decline to set up a new RAID 1 configuration on the disks, enter **No** at the prompt. The system prompts you to indicate which partition you would like the system installed on." +msgstr "2 - To decline to set up a new RAID 1 configuration on the disks, enter **No** at the prompt. The system prompts you to indicate which partition you would like the system installed on." #: ../../operation/raid.rst:79 -msgid "2 - To overwrite the old filesystem, enter “Yes”." -msgstr "2 - To overwrite the old filesystem, enter “Yes”." +msgid "2 - To overwrite the old filesystem, enter **Yes**." +msgstr "2 - To overwrite the old filesystem, enter **Yes**." #: ../../operation/raid.rst:131 msgid "3 - Enter the partition where you would like the system installed. The system then prompts you to indicate whether you want to save the old configuration data. This represents the current VyOS configuration." @@ -46,8 +46,8 @@ msgstr "3 - The system informs you that all data on both drives will be erased. #: ../../operation/raid.rst:88 #: ../../operation/raid.rst:139 -msgid "4 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." -msgstr "4 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." +msgid "4 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." +msgstr "4 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." #: ../../operation/raid.rst:167 msgid "4 - Format the new disk for RAID 1 by issuing the following command:" @@ -62,8 +62,8 @@ msgid "5 - Continue with installation in the normal way." msgstr "5 - Continue with installation in the normal way." #: ../../operation/raid.rst:96 -msgid "5 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." -msgstr "5 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." +msgid "5 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." +msgstr "5 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." #: ../../operation/raid.rst:99 msgid "6 - Continue with installation in the normal way." @@ -126,8 +126,8 @@ msgid "If a device is unplugged and re-plugged it will receive a new Port, Dev, msgstr "If a device is unplugged and re-plugged it will receive a new Port, Dev, If identification." #: ../../operation/raid.rst:57 -msgid "If you do not want to configure RAID 1 mirroring, enter “No” at the prompt and continue with installation in the normal way." -msgstr "If you do not want to configure RAID 1 mirroring, enter “No” at the prompt and continue with installation in the normal way." +msgid "If you do not want to configure RAID 1 mirroring, enter **No** at the prompt and continue with installation in the normal way." +msgstr "If you do not want to configure RAID 1 mirroring, enter **No** at the prompt and continue with installation in the normal way." #: ../../operation/information.rst:21 msgid "In the past serial interface have been defined as ttySx and ttyUSBx where x was an instance number of the serial interface. It was discovered that from system boot to system boot the mapping of USB based serial interfaces will differ, depending which driver was loaded first by the operating system. This will become rather painful if you not only have serial interfaces for a console server connected but in addition also a serial backed :ref:`wwan-interface`." diff --git a/docs/_locale/uk/operation.pot b/docs/_locale/uk/operation.pot index b835b3eea5..ff2aa04634 100644 --- a/docs/_locale/uk/operation.pot +++ b/docs/_locale/uk/operation.pot @@ -13,11 +13,11 @@ msgid "1 - Remove the failed disk from the RAID 1 set by issuing the following c msgstr "1. Видаліть несправний диск із набору RAID 1, виконавши таку команду:" #: ../../operation/raid.rst:113 -msgid "1 - To break apart the current RAID 1 set, enter “No” at the prompt. The" +msgid "1 - To break apart the current RAID 1 set, enter **No** at the prompt. The" msgstr "1. Щоб розбити поточний набір RAID 1, у запиті введіть «Ні». The" #: ../../operation/raid.rst:71 -msgid "1 - To create a new RAID 1 array, enter “Yes” at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." +msgid "1 - To create a new RAID 1 array, enter **Yes** at the prompt. If the system detects a filesystem on the partitions being used for RAID 1 it will prompt you to indicate whether you want to continue creating the RAID 1 array." msgstr "1. Щоб створити новий масив RAID 1, у запиті введіть «Так». Якщо система виявить файлову систему на розділах, що використовуються для RAID 1, вона запропонує вам вказати, чи бажаєте ви продовжити створення масиву RAID 1." #: ../../operation/raid.rst:162 @@ -25,11 +25,11 @@ msgid "2- Physically remove the failed disk from the system. If the drives are n msgstr "2- Фізично видаліть несправний диск із системи. Якщо диски не підтримують гарячу заміну, перед видаленням диска необхідно вимкнути систему." #: ../../operation/raid.rst:123 -msgid "2 - To decline to set up a new RAID 1 configuration on the disks, enter “No” at the prompt. The system prompts you to indicate which partition you would like the system installed on." +msgid "2 - To decline to set up a new RAID 1 configuration on the disks, enter **No** at the prompt. The system prompts you to indicate which partition you would like the system installed on." msgstr "2. Щоб відмовитися від налаштування нової конфігурації RAID 1 на дисках, у запиті введіть «Ні». Система запропонує вам вказати, на який розділ ви хочете встановити систему." #: ../../operation/raid.rst:79 -msgid "2 - To overwrite the old filesystem, enter “Yes”." +msgid "2 - To overwrite the old filesystem, enter **Yes**." msgstr "2 - Щоб перезаписати стару файлову систему, введіть «Так»." #: ../../operation/raid.rst:131 @@ -46,7 +46,7 @@ msgstr "3 - Система повідомляє, що всі дані на об #: ../../operation/raid.rst:88 #: ../../operation/raid.rst:139 -msgid "4 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." +msgid "4 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." msgstr "4 - Введіть «Так» у запиті, щоб зберегти поточну конфігурацію VyOS після завершення встановлення. Введіть «Ні», щоб видалити поточну конфігурацію VyOS." #: ../../operation/raid.rst:167 @@ -62,7 +62,7 @@ msgid "5 - Continue with installation in the normal way." msgstr "5 - Продовжте встановлення звичайним способом." #: ../../operation/raid.rst:96 -msgid "5 - Enter “Yes” at the prompt to retain the current VyOS configuration once installation is complete. Enter “No” to delete the current VyOS configuration." +msgid "5 - Enter **Yes** at the prompt to retain the current VyOS configuration once installation is complete. Enter **No** to delete the current VyOS configuration." msgstr "5 - Введіть «Так» у запиті, щоб зберегти поточну конфігурацію VyOS після завершення встановлення. Введіть «Ні», щоб видалити поточну конфігурацію VyOS." #: ../../operation/raid.rst:99 @@ -126,7 +126,7 @@ msgid "If a device is unplugged and re-plugged it will receive a new Port, Dev, msgstr "Якщо пристрій відключити та знову підключити, він отримає новий ідентифікатор Port, Dev, If." #: ../../operation/raid.rst:57 -msgid "If you do not want to configure RAID 1 mirroring, enter “No” at the prompt and continue with installation in the normal way." +msgid "If you do not want to configure RAID 1 mirroring, enter **No** at the prompt and continue with installation in the normal way." msgstr "Якщо ви не хочете налаштовувати дзеркальне відображення RAID 1, у запиті введіть «Ні» та продовжте інсталяцію звичайним способом." #: ../../operation/information.rst:21 diff --git a/docs/operation/raid.rst b/docs/operation/raid.rst index 2c835faf1a..bdc02b4a28 100644 --- a/docs/operation/raid.rst +++ b/docs/operation/raid.rst @@ -3,7 +3,7 @@ .. _raid: ###### -RAID-1 +RAID 1 ###### A Redundant Array of Independent Disks (RAID) uses two or more hard disk drives @@ -28,13 +28,13 @@ The VyOS implementation of RAID 1 features the following: .. _raid_installation: -Installation Implications +Installation implications ========================= The VyOS installation utility provides several options for installing to a RAID 1 set. You can: -* Use the install system to create the RAID 1 set +* Use the install system to create the RAID 1 set. * Use the built-in Linux commands to create a RAID 1 set before running the install system command. * Use a previously-created RAID 1 set. @@ -44,7 +44,7 @@ to a RAID 1 set. You can: Configuration ============= -Single disk, install as normal +Standard installation on a single disk ------------------------------ VyOS automatically detects the presence of two or more @@ -58,78 +58,75 @@ mirroring for eligible drives with the following prompt: * If you do not want to configure RAID 1 mirroring, enter **No** at the prompt. -Empty 2+ Disk +Empty 2+ disk ------------- -If VyOS system detect two identical disks that are not currently part of a -RAID-1 set, the VyOS installation utility automatically offers you the option -of configuring RAID 1 mirroring for the drives, with the following prompt. +If VyOS detects two identical disks that are not currently part of a +RAID 1 set, the VyOS installation utility automatically offers the option +to configure RAID 1 mirroring for the drives with the following prompt: .. code-block:: none Would you like to configure RAID 1 mirroring on them? -1 - To create a new RAID 1 array, enter “Yes” at the prompt. If the system -detects a filesystem on the partitions being used for RAID 1 it will prompt you +1. To create a new RAID 1 array, enter **Yes** at the prompt. If VyOS +detects a filesystem on the partitions being used for RAID 1, it will prompt you to indicate whether you want to continue creating the RAID 1 array. .. code-block:: none Continue creating array? -2 - To overwrite the old filesystem, enter “Yes”. +2. To overwrite the old filesystem, enter **Yes**. -3 - The system informs you that all data on both drives will be erased. You are -prompted to confirm that you want to continue +3. The system informs you that all data on both drives will be erased. +Confirm you want to continue. .. code-block:: none Are you sure you want to do this? -4 - Enter “Yes” at the prompt to retain the current VyOS configuration once -installation is complete. Enter “No” to delete the current VyOS -configuration. +4. Enter **Yes** at the prompt to retain the current VyOS configuration +Enter **No** to delete the current VyOS configuration. .. code-block:: none Would you like me to save the data on it before I delete it? -5 - Enter “Yes” at the prompt to retain the current VyOS configuration once -installation is complete. Enter “No” to delete the current VyOS configuration. +5. Enter **Yes** at the prompt to retain the current VyOS configuration. +Enter **No** to delete the current VyOS configuration. -6 - Continue with installation in the normal way. +6. Continue installing VyOS. -Present RAID-1 +Preexisting RAID 1 configuration -------------- -When the VyOS software on a system with a RAID 1 set already configured, -the installation utility will detect the array and will display the following -prompt: +When VyOS detects a previously configured RAID 1 set, +the installation utility displays the following prompt: .. code-block:: none Would you like to use this one? -1 - To break apart the current RAID 1 set, enter “No” at the prompt. The - +1. To break up the current RAID 1 set, enter **No** at the prompt. The installation utility detects that there are two identical disks and offers you -the option of configuring RAID 1 mirroring on them, displaying the following +the option of configuring RAID 1 mirroring with the following prompt: .. code-block:: none Would you like to configure RAID 1 mirroring on them? -2 - To decline to set up a new RAID 1 configuration on the disks, enter “No” -at the prompt. The system prompts you to indicate which partition you would +2. To decline to set up a new RAID 1 configuration on the disks, enter **No** +at the prompt. VyOS prompts you to indicate which partition you would like the system installed on. .. code-block:: none Which partition should I install the root on? [sda1]: -3 - Enter the partition where you would like the system installed. The system +3. Enter the partition where you would like the system installed. The system then prompts you to indicate whether you want to save the old configuration data. This represents the current VyOS configuration. @@ -137,54 +134,56 @@ data. This represents the current VyOS configuration. Would you like me to save the data on it before I delete it? -4 - Enter “Yes” at the prompt to retain the current VyOS configuration once -installation is complete. Enter “No” to delete the current VyOS configuration. +4. Enter **Yes** at the prompt to retain the current VyOS configuration once +installation is complete. Enter **No** to delete the current VyOS configuration. -5 - Continue with installation in the normal way. +5. Continue installing VyOS. -Detecting and Replacing a Failed RAID 1 Disk +Detecting and replacing a failed RAID 1 disk -------------------------------------------- -The VyOS system automatically detects a disk failure within a RAID 1 set and -reports it to the system console. You can verify the failure by issuing the -show raid command. +VyOS system detects disk failures within a RAID 1 set and +reports them to the system console. You can verify the failure by running the +``show raid`` command. -To replace a bad disk within a RAID 1 set, perform the following steps: +To replace a bad disk within a RAID 1 set: -1 - Remove the failed disk from the RAID 1 set by issuing the following -command: +1. Remove the failed disk from the RAID 1 set: -.. opcmd:: delete raid member + .. opcmd:: delete raid member - where RAID-1-device is the name of the RAID 1 device (for example, md0) and - disk-partition is the name of the failed disk partition (for example, sdb2). + where ``RAID-1-device`` is the name of the RAID 1 device. For example, + ``md0`` and + ``disk-partition`` is the name of the failed disk partition. For example, + ``sdb2``. -2- Physically remove the failed disk from the system. If the drives are not -hot-swappable, then you must shut down the system before removing the disk. +2. Physically remove the failed disk from the system. If the drives are not + hot-swappable, then you must shut down the system before removing the disk. -3 - Replace the failed drive with a drive of the same size or larger. +3. Replace the failed drive with a drive of the same size or larger. -4 - Format the new disk for RAID 1 by issuing the following command: +4. Format the new disk for RAID 1 by running the following command: -.. opcmd:: format disk like + .. opcmd:: format disk like - where disk-device1 is the replacement disk (for example, sdb) and - disk-device2 is the existing healthy disk (for example, sda). + where ``disk-device1`` is the replacement disk. For example, ``sdb`` and + ``disk-device2`` is the existing healthy disk. For example, ``sda``. -5-Add the replacement disk to the RAID 1 set by issuing the following command: +5. Add the replacement disk to the RAID 1 set by running the following command: -.. opcmd:: add raid member + .. opcmd:: add raid member - where RAID-1-device is the name of the RAID 1 device (for example, md0) and - disk-partition is the name of the replacement disk partition - (for example, sdb2). + where ``RAID-1-device`` is the name of the RAID 1 device. For example, + ``md0`` and + ``disk-partition`` is the name of the replacement disk partition. + For example, ``sdb2``. Operation ========= -This part introduces how to add a disk partition to a RAID-1 set initiates -mirror synchronization, check and display information. +Learn how to add a disk partition to a RAID 1 set, initiate +mirror synchronization, and check and display information. .. opcmd:: add raid member @@ -195,11 +194,11 @@ mirror synchronization, check and display information. .. opcmd:: format disk like This command is typically used to prepare a disk to be added to a preexisting - RAID 1 set (of which disk-device2 is already a member). + RAID 1 set (of which ``disk-device2`` is already a member). .. opcmd:: show raid - shows output for show raid md0 as sdb1 is being added to the RAID 1 + shows output for ``show raid md0`` as ``sdb1`` is being added to the RAID 1 set and is in the process of being resynchronized. .. code-block:: none @@ -228,7 +227,7 @@ mirror synchronization, check and display information.      0       8        1        0      active sync   /dev/sda1      2       8       17        1      spare rebuilding   /dev/sdb1 -.. opcmd:: show raid +.. opcmd:: show disk sda format Use this command to display the formatting of a hard disk. From fcf95c03ad64eb7d3a8eccdc04a58fbe573a3ecc Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Fri, 28 Nov 2025 07:18:40 +0900 Subject: [PATCH 10/15] Update upgrade-recovery timeout explanation --- docs/operation/upgrade-recovery.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/operation/upgrade-recovery.rst b/docs/operation/upgrade-recovery.rst index cec0211011..c584a15988 100644 --- a/docs/operation/upgrade-recovery.rst +++ b/docs/operation/upgrade-recovery.rst @@ -29,8 +29,9 @@ To enable upgrade recovery, run the following command: set system option reboot-on-upgrade-failure [timeout ] -* ``timeout :`` The time in minutes (5 - 30) you have to cancel upgrade - recovery. See :ref:`Cancelling Recovery `. +* ``timeout :`` The time in minutes (5 - 30) to cancel upgrade + recovery before VyOS reboots. + See :ref:`Cancelling Recovery `. .. _how_it_works: From c22d0a36d0e70d8db450428537a34084d0edf746 Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Sun, 30 Nov 2025 16:18:54 +0900 Subject: [PATCH 11/15] Fix header formatting --- docs/operation/raid.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/operation/raid.rst b/docs/operation/raid.rst index bdc02b4a28..7c925b5c64 100644 --- a/docs/operation/raid.rst +++ b/docs/operation/raid.rst @@ -45,7 +45,7 @@ Configuration ============= Standard installation on a single disk ------------------------------- +-------------------------------------- VyOS automatically detects the presence of two or more disks that are not currently part of a RAID array when installed. The VyOS From 786eb2e0994add4100ffd57b074ba1bf07c6305a Mon Sep 17 00:00:00 2001 From: Quill <69414602+teslazonda@users.noreply.github.com> Date: Sun, 30 Nov 2025 16:21:18 +0900 Subject: [PATCH 12/15] Update docs/operation/boot-options.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/operation/boot-options.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/operation/boot-options.rst b/docs/operation/boot-options.rst index 67654b1ab4..250b484d44 100644 --- a/docs/operation/boot-options.rst +++ b/docs/operation/boot-options.rst @@ -14,7 +14,7 @@ Boot Options VyOS provides several kernel command-line options to modify the normal boot process. To add an option, select the desired image in the GRUB menu at load time. -Type **e** to edit the first line, then type **Ctrl+x** to boot. +Type **e** to edit the first line, then type **Ctrl+X** to boot. .. image:: /_static/images/boot-options.png :width: 80% From 1510dfd881d6be141ba44bb370150ad4bd0e86fe Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Sun, 30 Nov 2025 16:27:16 +0900 Subject: [PATCH 13/15] Add missing period in raid.rst --- docs/operation/raid.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/operation/raid.rst b/docs/operation/raid.rst index 7c925b5c64..9baf52f4da 100644 --- a/docs/operation/raid.rst +++ b/docs/operation/raid.rst @@ -86,7 +86,7 @@ Confirm you want to continue. Are you sure you want to do this? -4. Enter **Yes** at the prompt to retain the current VyOS configuration +4. Enter **Yes** at the prompt to retain the current VyOS configuration. Enter **No** to delete the current VyOS configuration. .. code-block:: none From 024659be20b4e7cb0cfe345ea172d252f2e7230d Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Sun, 30 Nov 2025 16:38:03 +0900 Subject: [PATCH 14/15] Implement Copilot feedback --- docs/operation/information.rst | 10 +++++----- docs/operation/raid.rst | 5 ++--- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/operation/information.rst b/docs/operation/information.rst index 7b541bc9c0..edddee02c9 100644 --- a/docs/operation/information.rst +++ b/docs/operation/information.rst @@ -20,15 +20,15 @@ USB === In the past, serial interfaces were defined as ``ttySx`` and ``ttyUSBx`` where -``x`` -was the instance number. However, the mapping of USB-based serial interfaces -can change from one system boot to another, depending on which driver the -operating system loads first. This inconsistency can be problematic when you +``x`` was the instance number. However, the mapping of USB-based +serial interfaces can change from one system boot to another, depending on +which driver the operating system loads first. +This inconsistency can be problematic when you use multiple serial interfaces. For example, both console-server connections and a serial-backed :ref:`wwan-interface`. -To address this issue, and because of many low-cost USB-to-serial converters +To address this issue, and because many low-cost USB-to-serial converters do not have a programmed serial number, VyOS now identifies USB-to-serial interfaces by the USB root bridge and the bus they connect to. This approach is similar to the network interface naming conventions used in diff --git a/docs/operation/raid.rst b/docs/operation/raid.rst index 9baf52f4da..b8dac2b5b5 100644 --- a/docs/operation/raid.rst +++ b/docs/operation/raid.rst @@ -100,7 +100,7 @@ Enter **No** to delete the current VyOS configuration. Preexisting RAID 1 configuration --------------- +-------------------------------- When VyOS detects a previously configured RAID 1 set, the installation utility displays the following prompt: @@ -175,8 +175,7 @@ To replace a bad disk within a RAID 1 set: .. opcmd:: add raid member where ``RAID-1-device`` is the name of the RAID 1 device. For example, - ``md0`` and - ``disk-partition`` is the name of the replacement disk partition. + ``md0`` and ``disk-partition`` is the name of the replacement disk partition. For example, ``sdb2``. Operation From 18949d8040e2e6a2fe42c71f2e9c0273e9bb0f8d Mon Sep 17 00:00:00 2001 From: Quill Cronwall Date: Sun, 30 Nov 2025 16:46:57 +0900 Subject: [PATCH 15/15] Update capitalization in information.rst --- docs/operation/information.rst | 4 ++-- docs/operation/upgrade-recovery.rst | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/operation/information.rst b/docs/operation/information.rst index edddee02c9..f6a2f92cca 100644 --- a/docs/operation/information.rst +++ b/docs/operation/information.rst @@ -2,9 +2,9 @@ .. _information: -*********** +****************** System Information -*********** +****************** VyOS features a rich set of operational level commands to retrieve arbitrary information about your running system. For more information on the VyOS command diff --git a/docs/operation/upgrade-recovery.rst b/docs/operation/upgrade-recovery.rst index c584a15988..d6eeb6781f 100644 --- a/docs/operation/upgrade-recovery.rst +++ b/docs/operation/upgrade-recovery.rst @@ -11,8 +11,8 @@ Use **VyOS upgrade recovery** to restore the system to the last working version after a failed upgrade. * :ref:`Configuration: ` How to enable upgrade recovery -* :ref:`How it Works: ` Overview of the recovery process -* :ref:`Cancelling Recovery: ` Overview of the recovery +* :ref:`How it works: ` Overview of the recovery process +* :ref:`Cancelling recovery: ` Overview of the recovery process .. _configuration: @@ -36,7 +36,7 @@ To enable upgrade recovery, run the following command: .. _how_it_works: ************ -How it Works +How it works ************ After a VyOS upgrade, the system monitors the boot process. Upon detecting a boot failure, VyOS initiates a revert to the last working version and displays @@ -61,7 +61,7 @@ timeout. Upon successful recovery and reboot, the following message appears: .. _cancelling_recovery: ******************* -Cancelling Recovery +Cancelling recovery ******************* Upon detecting a boot failure, you have the predefined timeout to cancel upgrade recovery. This is useful if you want to troubleshoot the faulty VyOS