From 7b49f693d90cb820bf2d4f1b60c802a73d45d207 Mon Sep 17 00:00:00 2001 From: Daniel Hancock Date: Wed, 11 Sep 2024 00:24:11 +0800 Subject: [PATCH] docs: Add missing docs for getting started section Signed-off-by: Daniel Hancock --- content/en/docs/users/_index.md | 4 ++ .../en/docs/users/getting_started/_index.md | 6 ++ .../booting_the_live_enviroment.md | 33 +++++++++ .../creating_the_live_enviroment.md | 69 +++++++++++++++++++ .../getting_started/downloading_serpentos.md | 65 +++++++++++++++++ .../users/getting_started/requirements.md | 42 +++++++++++ 6 files changed, 219 insertions(+) create mode 100644 content/en/docs/users/getting_started/_index.md create mode 100644 content/en/docs/users/getting_started/booting_the_live_enviroment.md create mode 100644 content/en/docs/users/getting_started/creating_the_live_enviroment.md create mode 100644 content/en/docs/users/getting_started/downloading_serpentos.md create mode 100644 content/en/docs/users/getting_started/requirements.md diff --git a/content/en/docs/users/_index.md b/content/en/docs/users/_index.md index 507ae25..bd51a33 100644 --- a/content/en/docs/users/_index.md +++ b/content/en/docs/users/_index.md @@ -3,3 +3,7 @@ title = 'Users' date = 2024-09-10T00:04:48Z description = "Documentation for daily users of Serpent OS" +++ + +{{< alert color="warning" >}} +Currently we are in pre-alpha stage of development so please expect breakages and bugs. We are working hard to get to a stable release. +{{< /alert >}} diff --git a/content/en/docs/users/getting_started/_index.md b/content/en/docs/users/getting_started/_index.md new file mode 100644 index 0000000..4ae26ff --- /dev/null +++ b/content/en/docs/users/getting_started/_index.md @@ -0,0 +1,6 @@ ++++ +title = 'Getting Started' +date = 2024-09-10T23:25:15+08:00 +description = "Getting started with Serpent OS" +weight = 10 ++++ diff --git a/content/en/docs/users/getting_started/booting_the_live_enviroment.md b/content/en/docs/users/getting_started/booting_the_live_enviroment.md new file mode 100644 index 0000000..f84fe77 --- /dev/null +++ b/content/en/docs/users/getting_started/booting_the_live_enviroment.md @@ -0,0 +1,33 @@ ++++ +title = 'Booting the Live Environment' +date = 2024-09-10T23:57:02+08:00 +description = "Booting into the Serpent OS Live Environment" +weight = 40 ++++ + +## Booting from a USB Drive + +{{< alert color="primary" >}} +Ensure that your system is set to boot from the USB drive. You may need to access the boot menu to select the USB drive as the boot device. +{{< /alert >}} + +{{< alert color="secondary" >}} +Currently NVIDIA Drivers are not implemented by the live environment and will fallback to nouveau drivers. +{{< /alert >}} + +1. Insert the bootable USB drive into your system and boot from the USB drive. +2. You should see the Serpent OS boot process, and you will be presented with the live environment. + +## Testing the Live Environment + +{{< alert color="info" >}} +The live environment may run slower than the installed system due to the limitations of running from a USB drive. +{{< /alert >}} + +Once you have booted into the live environment, you can test Serpent OS without installing it on your system. + +- Explore the desktop environment. +- Test the pre-installed applications. +- Check the system performance. +- Verify the hardware compatibility. +- Connect to the internet and browse the web. diff --git a/content/en/docs/users/getting_started/creating_the_live_enviroment.md b/content/en/docs/users/getting_started/creating_the_live_enviroment.md new file mode 100644 index 0000000..be08cd2 --- /dev/null +++ b/content/en/docs/users/getting_started/creating_the_live_enviroment.md @@ -0,0 +1,69 @@ ++++ +title = 'Creating the Live Environment' +date = 2024-09-10T23:43:21+08:00 +description = "Creating a live environment to boot into and run the Serpent OS installer" +weight = 30 ++++ + +## Creating a Bootable USB Drive + +{{< alert color="warning" >}} +Creating a bootable USB drive will erase all data on the USB drive. Make sure to back up any important data before proceeding. +{{< /alert >}} + +{{< alert color="secondary" >}} +Ensure the USB drive is properly ejected after flashing the ISO to avoid data corruption. +{{< /alert >}} + +You'll need your USB drive and the ISO file downloaded from the [Serpent OS download page](https://download.serpentos.com). + +### Linux + +1. Insert your USB drive into an available USB port on your machine. +2. Open a terminal window and navigate to the directory where the ISO file is located. + +```bash +cd ~/Downloads +``` + +3. Identify the device name of your USB drive by running the following command: + +```bash +lsblk +``` + +Look for the device name of your USB drive, it will be something like `/dev/sdX` where `X` is a letter representing the device. + +{{< alert color="warning" >}} +Do not confuse this with the partition name, which will be something like `/dev/sdX1`. +{{< /alert >}} + +4. Now run the following command to write the ISO file to the USB drive: + +{{< alert color="warning" >}} +Ensure you are using the correct device name for your USB drive to avoid data loss. +{{< /alert >}} + +{{< alert color="primary" >}} +This may take some time to complete depending on the size of the ISO file and the speed of your USB drive. +{{< /alert >}} + +```bash +sudo dd if=serpentos-.iso of=/dev/sdX bs=4M conv=fsync oflag=direct status=progress +``` + +This command will write the ISO file to the USB drive and you'll see a progress indicator as it completes. + +5. To ensure the write process has completed successfully, run the following command: + +```bash +sudo sync +``` + +Once the command has run, you can safely remove the USB drive from your machine. + +### Windows + +1. Insert your USB drive into an available USB port on your machine. +2. Download and install [Rufus](https://rufus.ie/), a free and open-source tool for creating bootable USB drives. +3. **TODO**: Add steps for using Rufus to create a bootable USB drive. diff --git a/content/en/docs/users/getting_started/downloading_serpentos.md b/content/en/docs/users/getting_started/downloading_serpentos.md new file mode 100644 index 0000000..a88f3bc --- /dev/null +++ b/content/en/docs/users/getting_started/downloading_serpentos.md @@ -0,0 +1,65 @@ ++++ +title = 'Downloading Serpent OS' +date = 2024-09-10T23:36:23+08:00 +description = "Downloading the Serpent OS ISO file and verifying the checksums" +weight = 20 ++++ + +## Downloading the ISO + +1. Visit the [Serpent OS download page](https://download.serpentos.com). +2. Look for the latest release available for download, the official ISO files are named `serpentos-.iso`. + + {{< alert color="primary" >}} + Their may be multiple versions available with different desktop environments donoted by `serpentos--.iso` where `` is the desktop environment. + {{< /alert >}} + +3. Click on the download link to start downloading the ISO file and assiocated checksums donated by `serpentos-.iso.sha256`. + +Once the download is complete, you can proceed with creating a bootable USB drive or burning the ISO to a DVD to install Serpent OS on your machine. + +## Verifying the Checksums + +Before creating a bootable USB drive or burning the ISO to a DVD, it's important to verify the checksums to ensure the integrity of the downloaded ISO file. + +{{< alert color="warning" >}} +Using the ISO file without verifying the checksums can lead to boot failures, installation issues, and potential security risks. +{{< /alert >}} + +### Linux + +1. Open a terminal window and navigate to the directory where the ISO file is located along with the checksums. + +```bash +cd ~/Downloads +``` + +2. Run the following command to verify the checksums: + +```bash + +sha256sum -c +``` +You should see a message indicating that the checksums match if the ISO file is valid. + +```bash +serpent-os.iso: OK +``` + +If the checksums do not match, download the ISO file again and repeat the verification process. + +### Windows + +1. Open a Command Prompt window and navigate to the directory where the ISO file is located along with the checksums. + +```cmd +cd C:\Users\\Downloads +``` + +2. Run the following command to verify the checksums: + +```cmd +certutil -hashfile serpent-os-.iso SHA256 +``` + +This will give you the checksum of the file, compare this to the checksum found inside the checksum file. diff --git a/content/en/docs/users/getting_started/requirements.md b/content/en/docs/users/getting_started/requirements.md new file mode 100644 index 0000000..0e7044f --- /dev/null +++ b/content/en/docs/users/getting_started/requirements.md @@ -0,0 +1,42 @@ ++++ +title = 'Requirements' +date = 2024-09-10T23:00:44+08:00 +description = "Requirements for Serpent OS" +weight = 10 ++++ + +## Minimum System Requirements + +{{< alert color="info" >}} +BOIS/CSM mode is not supported. Please ensure that your system is set to UEFI mode. +{{< /alert >}} + +- **Architecture:** x86_64 +- **Firmware:** UEFI (CSM Support must be disabled) +- **Processor (CPU):** Quad-core processor with a minimum clock speed of 2GHz +- **System Memory (RAM):** 4GB or more +- **Storage:** Minimum of 40GB available space + +## Installer Requirements + +To successfully create a bootable USB drive for installing Serpent OS, the following requirements must be met: + +- **Network:** An active internet connection is required for installation +- **USB Flash Drive:** Ensure you have a USB flash drive with at least 4GB of free space. + + {{< alert color="warning" >}} + The process of flashing the ISO will completely erase all existing data on the drive. + {{< /alert >}} + + {{< alert color="info" >}} + It is advisable to use a high-quality USB drive to avoid potential issues during the installation process. + {{< /alert >}} + +- **Image Flashing Software:** Utilize one of the following recommended tools to flash the Serpent OS ISO image onto the USB drive: + - **dd:** A command-line utility available on most Linux distributions for creating bootable USB drives. + - **Fedora Media Writer:** A reliable and user-friendly tool for creating bootable USB drives. + - **Rufus:** A widely-used utility that provides advanced options for creating bootable USB drives. + - **Balena Etcher:** A simple and user-friendly tool for creating bootable USB drives. + - **Ventoy:** An open-source tool that allows you to create a bootable USB drive for multiple ISO files. + +- **Additional Hardware:** A physical keyboard, mouse, and monitor (or screen) are required to interact with the installation process. Ensure that all these peripherals are properly connected to the system before starting the installation.