From 40f990efb9a0b26204b224afb0c97a3fc52bd41a Mon Sep 17 00:00:00 2001 From: Cappy Ishihara Date: Mon, 4 Dec 2023 14:59:24 +0700 Subject: [PATCH] Fix typos and formatting in installation documentation --- .../docs/en/installation/getting-started.mdx | 5 ++--- .../docs/en/installation/installation.mdx | 18 +++++++++--------- .../docs/en/installation/postinstall.mdx | 16 +++++++++++++++- src/styles/index.css | 10 ++++++++++ 4 files changed, 36 insertions(+), 13 deletions(-) diff --git a/src/content/docs/en/installation/getting-started.mdx b/src/content/docs/en/installation/getting-started.mdx index 86d411ed..7bf34f23 100644 --- a/src/content/docs/en/installation/getting-started.mdx +++ b/src/content/docs/en/installation/getting-started.mdx @@ -103,13 +103,12 @@ Before your computer boots to your current OS, please refer to your computer's d -Most computers have a special key that can be used to select a boot device, or to enter the setup screen. This varies from brand to brand. These keys may be `Esc`, one of the function keys,, or even `Delete`. The BIOS will usually display a message on the screen briefly on startup. If you're not sure which key to press, look up the key for your computer manufacturer. - +Most computers have a special key that can be used to select a boot device, or to enter the setup screen. This varies from brand to brand. These keys may be Esc, one of the function keys, or even Delete. The BIOS will usually display a message on the screen briefly on startup. If you're not sure which key to press, look up the key for your computer manufacturer. -On Intel Macs, press power, then hold down the `Alt` or `Option` key until disk icons appear. +On Intel Macs, press power, then hold down the Alt or Option key until disk icons appear. diff --git a/src/content/docs/en/installation/installation.mdx b/src/content/docs/en/installation/installation.mdx index 4df75efd..7bf52ab0 100644 --- a/src/content/docs/en/installation/installation.mdx +++ b/src/content/docs/en/installation/installation.mdx @@ -5,17 +5,17 @@ description: "A guide on how to install Ultramarine Linux" import Alert from "../../../../components/Docs/Alert.astro"; -After booting into the live system, you will see a dialog box asking you to whether to start the installer, or continue with the live system. +After booting into the live system, you will see a dialog box asking you whether to start the installer or continue with the live system. ![The Welcome Dialog box](/assets/welcome-window.png) You can pick whichever you want, and you'll be able to start the installer later by opening the `Install to Hard Drive` application. -To start the installation, click on the `Install to Hard Drive` button, or open the `Install to Hard Drive` application. +To start the installation, click on the `Install to Hard Drive` button or open the `Install to Hard Drive` application. # The Anaconda Installer -Ultramarine currently uses the [Anaconda Installer]() (not to be confused with [The Python distribution]()). This is a system installer similar to the likes of Ubuntu's Ubiquity, or Calamares. +Ultramarine currently uses the [Anaconda Installer]() (not to be confused with [The Python distribution]()). This is a system installer similar to the likes of Ubuntu's Ubiquity or Calamares. There has been progress to replace the installer with a custom installer, but it is very experimental and not yet ready for normal use. @@ -41,9 +41,9 @@ Once you have selected the keyboard layout, you can press the `Done` button on t ![](/assets/anaconda-4.png) -The Time & Date selection screen has a world map in which where you can click on your location on the map to set your timezone. +The Time & Date selection screen has a world map where you can click on your location on the map to set your timezone. -You can also use custom NTP servers to sync your time with a different server by clicking on the cog icon in the top right, or automatically set your time from your geolocation. +You can also use custom NTP servers to sync your time with a different server by clicking on the cog icon in the top right or automatically set your time from your geolocation. @@ -83,7 +83,7 @@ In this mode, Anaconda uses a tool called blivet-gui for you to manually partiti You can set up your custom partitioning scheme, along with your own custom mount points and file system types. -You can also set up disk encryption using LUKS2 for extra security, but you will have to manually type in your password everytime your system boots. +You can also set up disk encryption using LUKS2 for extra security, but you will have to manually type in your password every time your system boots. ### Networking @@ -101,13 +101,13 @@ On live installations, you can only configure your hostname. Everything else wil ![](/assets/anaconda-9.png) -In this screen, you will have to configure your user accounts. Create a system account and enter in your password to continue. +In this screen, you will have to configure your user accounts. Create a system account and enter your password to continue. You can also click on the `Advanced` button for a more in-depth configuration of your account, such as your user folder location, account ID, and your system group membership. -If you do not enter in a password, some apps may not work properly. +If you do not enter a password, some apps may not work properly. @@ -122,7 +122,7 @@ If you type in a password that Anaconda deems insecure, it will have you confirm After completing your system configuration, press the `Begin Installation` button to continue. The installation process will start and may take a few minutes. - This process **IRREVERSIBLE**. If you manage to close down the installer + This process is **IRREVERSIBLE**. If you manage to close down the installer before it finishes, you will end up with a corrupted system.
To fix this, you will have to reinstall Ultramarine Linux or your preferred operating system, causing data loss. diff --git a/src/content/docs/en/installation/postinstall.mdx b/src/content/docs/en/installation/postinstall.mdx index 71ef3997..b6f762aa 100644 --- a/src/content/docs/en/installation/postinstall.mdx +++ b/src/content/docs/en/installation/postinstall.mdx @@ -25,6 +25,11 @@ Then, reboot your system. ### Use NVIDIA Graphics Card as the primary card on Optimus Laptops + +This change is is completely optional. You can skip this step if you don't want to use your NVIDIA Graphics Card as the primary card, or you do not use +a dual-GPU laptop conntected to an external monitor. It may also cause issues with some applications, such as Steam and Bottles. + + Run the following commands to make your NVIDIA Graphics Card the primary Graphics Card: ```bash @@ -40,6 +45,15 @@ Make sure you're using the Xorg version of your desktop environment. Ultramarine Linux includes codecs for most of the media you'll come across. You shouldn't need to install any additional codecs. -## Set up Snapper (Btrfs Snapshots) +## Set up backups + +You may want to back up your files to an external volume, you can use [Pika Backup] or [Déjà Dup] to do so. + +Instructions are available on the [Déjà Dup] and [Pika Backup] websites. + +[Déjà Dup]: https://wiki.gnome.org/Apps/DejaDup +[Pika Backup]: https://apps.gnome.org/PikaBackup/ + +### Set up Snapper (Btrfs Snapshots) Currently, RPM's architecture does not handle snapper properly. You might experience broken RPM transactions when doing rollbacks. This is a known issue and must be addressed upstream. diff --git a/src/styles/index.css b/src/styles/index.css index f93d5b0f..d35016b8 100644 --- a/src/styles/index.css +++ b/src/styles/index.css @@ -277,6 +277,16 @@ blockquote { line-height: 1.7; } +kbd { + font-family: var(--font-mono); + font-size: 0.85em; + color: var(--theme-text-light); + background-color: var(--theme-bg-offset); + padding: 0.1em 0.4em; + border-radius: 3px; + border: 1px solid gray; +} + img { max-width: 100%; }