diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f115447..d4bcc3ac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,107 +1,107 @@ # Contributing to the Lubuntu Manual Contributing to the Lubuntu Manual is simple and easy to do if you know how to do it. This guide is meant to show how to contribute to the Lubuntu Manual. ## Tools needed Before starting, you need a few tools. - A modern, Debian-based Linux distribution - Debian Jessie (8.0) and onwards - Ubuntu 16.04 LTS and onwards - The following packages from your Linux distribution's repository: - `git` - - `pyhton3-pip` + - `python3-pip` - `arcanist` - `python3-sphinx` - `texlive` - `texlive-formats-extra` - `latexmk` - `python3-sphinx-rtd-theme` ## Getting the code To clone the repository, you can run this command: ``` -git clone ssh://git@phab.lubuntu.me:2222/source/lubuntu-manual.git +git clone ssh://git@phab.lubuntu.me/source/manual.git ``` but to do this you must have your ssh key on phabricator. ## Adding a file to the manual After setting up the tools, you should now be ready to start editing files. If you look in the `source` directory, you should see some files. There's `index.rst`, which is the main page, and some directories and subdirectories that are numbers. Those are chapters of the book, and are listed in the `index.rst` file. Let's say you want to create Chapter 20. In the `source` directory, create a directory titled `20`. In the `20` directory, create a file with the name of the chapter. Let's call this chapter `foo bar`. Create a file named `foo_bar.rst` in `20`. Edit that file however you want. When you are done, add this to `source/index.rst`: ``` Contents ======== .. toctree:: :maxdepth: 2 :titlesonly: ... 20/foo_bar ``` Then run `make clean && make html && make latexpdf` in the root of the manual directory and it should build successfully with zero warnings! ## Getting multiple Versions to Work To change into the file for the code you cloned from git of sphinxconfig-versioning and run ``` cd sphinxcontrib-versioning && sudo python3 setup.py install``` ## Making changes and seeking your changes to be pulled **Before you do the below, please update PROGRESS.md to reflect your changes.** So let's say you make your changes. You like them and think they should be included in the mainline manual. Here's what you have to do: First, tell Git to track the changes in the files you just modified: ``` git add foo bar source/baz ``` Then, commit the files: ``` git commit -am "I changed x in foo, y in bar, and z in baz" # For a multi-line commit: git commit -a # To only commit some files: git commit -m "I changed x in foo and y in bar" foo bar ``` To submit your code, or push to your Launchpad account and submit a merge request, both will be seen by someone with the permission to merge. Push to the following repository to be able to submit a merge proposal on differential after registering an account on the Lubuntu phabricator. ``` arc diff ``` Another option if you prefer would be to send patch mail to [lubuntu-devel@lists.ubuntu.com](mailto:lubuntu-devel@lists.ubuntu.com). This assumes you are already familiar with patch mail and you know how. Please prefix the subject with `[Lubuntu Manual Patch]` and we'll discuss the patch with you on the mailing list. **Please check for spelling mistakes and errors before submitting your merge proposal or pull request.** ## Specification/What is there to do? In `spec.rst`, there is an editable outline of items to be accomplished, a precompiled version with spec.pdf description of items to be accomplished, and on `PROGRESS.md`, there is our status in completing that specification. In the specification if you make changes run ``` rst2pdf spec.rst" Pick out something to do, but before you start, please indicate on the [lubuntu-devel mailing list](https://lists.ubuntu.com/mailman/listinfo/Lubuntu-devel) or on [#lubuntu-devel on freenode](https://kiwiirc.com/client/irc.freenode.net/#lubuntu-devel) to state that you intend to complete what you have picked out. Please also look at `PROGRESS.md` to see what still needs to be completed. diff --git a/README.md b/README.md index 2be7e197..4ab9596f 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,27 @@ # Lubuntu Manual Source Code This is the Lubuntu Manual source code. The concept was derived from [the Kubuntu Manual](https://github.com/ahoneybun/kubuntu-manual). The master branch of this data is now on LXQt for Lubuntu 18.10+ and if you want code for earlier versions it is on the LXDE branch. For each relase of a distro go to the numerical number of that release such as 19.10. To see what is currently in master [manual master branch](https://manual.lubuntu.me/master/) and to see the current stable version look at [stable manual branch](https://manual.lubuntu.me/stable/) ## How it works The documentation is powered by [Sphinx](http://www.sphinx-doc.org/en/stable/) and is written in reStructuredText. Run the following command to install the needed dependencies: ``` sudo apt install python3-pip python3-sphinx latexmk texlive texlive-formats-extra arcanist python3-sphinx-rtd-theme python3-sphinx-bootstrap-theme ``` You can see the options for building the documentation by running `make help`. You can make the html version by running `make html`. You can make a pdf version of the lubuntu manual with `make latexpdf`. If you just want to check for warnings or errors building run `make dummy`. ## Contributing To contribute to the Lubuntu Manual, you can either create a request on Launchpad, or send patch mail to [lubuntu-devel@lists.ubuntu.com](mailto:lubuntu-devel@lists.ubuntu.com) and prefix the subject with `[Lubuntu Manual Pull Request]`. If you really want to learn more about sphinx to help Lyn Perrine found this pycon video helpful [Carol_Willing-Practical_Sphinx] (https://www.youtube.com/watch?v=0ROZRNZkPS8) If you want short help on how to format things see StyleGuide.rst in this directory. ## License -This work is licensed under a Creative Commons Attribution 4.0 International License. More details can be found here: [creative commons attribution liscense](http://creativecommons.org/licenses/by/4.0/) +This work is licensed under a Creative Commons Attribution 4.0 International License. More details can be found here: [creative commons attribution license](http://creativecommons.org/licenses/by/4.0/) diff --git a/source/1/1.1/retrieving_the_image.rst b/source/1/1.1/retrieving_the_image.rst index 03ffa091..444a01da 100644 --- a/source/1/1.1/retrieving_the_image.rst +++ b/source/1/1.1/retrieving_the_image.rst @@ -1,82 +1,82 @@ Chapter 1.1 Retrieving the image ================================= -Before you install Lubuntu, you need to retrieve the correct image. Lubuntu provides supports AMD64 CPU types also known as 64 bit with a new version every six months (supported for nine months), and every two years being a long term support release (supported for three years). If you have a 32 bit processor we unfortunately had to drop support but 18.04 LTS is still supported until 2021 for 32 bit. Lubuntu 20.04 is a Long term support release supported until 2023. +Before you install Lubuntu, you need to retrieve the correct image. Lubuntu supports AMD64 CPU types also known as 64-bit with a new version every six months (supported for nine months), and every two years being a long term support release (supported for three years). If you have a 32 bit processor we unfortunately had to drop support but 18.04 LTS is still supported until 2021 for 32 bit. Lubuntu 20.04 is a Long Term Support release supported until 2023. LTS vs. Regular Releases ------------------------ -Lubuntu offers two types of releases. The **Long Term Support** release, or the **LTS**, is the release recommended for most users. It is supported for three years after the release date and does not contain new features. Throughout the course of the cycle, the Ubuntu Kernel Team will deliver **Hardware Enablement** updates, or **HWE** updates, to Lubuntu via Linux kernel updates. Lubuntu 20.04 is the First **Long Term Support** release which uses the more modern **LXQt** desktop envionrment. Since Lubuntu 18.10 has used the **LXQt** previously Lubuntu used **LXDE**. +Lubuntu offers two types of releases. The **Long Term Support** release, or the **LTS**, is the release recommended for most users. It is supported for three years after the release date and does not contain new features. Throughout the course of the cycle, the Ubuntu Kernel Team will deliver **Hardware Enablement** updates, or **HWE** updates, to Lubuntu via Linux kernel updates. Previously, Lubuntu used **LXDE** but since 18.10 it has used the **LXQt**. Lubuntu 20.04 is the First **Long Term Support** release which uses the more modern **LXQt** desktop environment. For users looking to try new features every six months at the expense of the support cycle length, Lubuntu offers **interim releases**, or **regular releases**. These releases, while they are considered stable, are testing grounds for major, new features which will be rolled into the LTS release. Users of the regular releases are typically enthusiasts and somewhat more experienced users looking for a fresher experience. **It is extremely important that if you choose this path, you upgrade to each successive regular release shortly after it comes out.** If you are not comfortable doing this, you should consider using the LTS release instead. Ways to download the image --------------------------- Now that the decision of which architecture and release type you need is made, you will need to download the image. There are several ways to download the Lubuntu image: - HTTP download (from your web browser or terminal). - BitTorrent (from a BitTorrent client such as Transmission, recommended for Windows and macOS users). - zsync (from the terminal, recommended for Linux users). You can also download the image via Jigdo but we will not cover that in this manual. An easy download page which lists the HTTP and BitTorrent downloads is available `on the Lubuntu website's Downloads page `_, however for zsync downloads, you need to visit `cdimage.ubuntu.com `_, which has the files listed. Below you can find more detailed notes on each download method. Downloading the image via HTTP ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ *We don't recommend using this method as it's often slower, more error prone, and less efficient than the other methods.* After you download the image, you **must** verify it, as this is the most common reason there are problems with a Lubuntu install. There is `a helpful page on the Ubuntu Community Help wiki `_ that can guide you in the right direction. .. warning:: Downloading via HTTP and not verifying the image can lead to hours of frustration with even the developers quite confused what is happening with your system. With just one bit of the image flipped will cause massive frustration and a failed install. To verify the image, run this from the command line: .. code:: sha256sum lubuntu-20.04-desktop-amd64.iso and then carefully check that the output matches cc18a581d2e4d86f3f29ef44c12a0c42b54cde93db9fc5f7c3f10db1aff3fa9a *lubuntu-20.04-desktop-amd64.iso Downloading the image via BitTorrent ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Instead of downloading the image from one server, you can "torrent" the image, or download it from multiple sources instead of just one. This is often faster and saves the bandwidth of the Ubuntu cdimage servers. If you would like to learn more about BitTorrent, take a look at `the Wikipedia page on the subject `_. In order to torrent the file, you need a BitTorrent client. We recommend `Transmission `_, an Open Source BitTorrent client. Since Transmission only provides clients for Linux and macOS, we recommend `qbittorrent `_ for Windows users. The BitTorrent links can be found on our Downloads page or `cdimage.ubuntu.com`_ , both linked above. After you have downloaded the link you need, open it in your BitTorrent client. This will download the image. After this is done, we recommend that you leave your BitTorrent client open so you can seed this image for other people, which helps reduce bandwidth costs even further by decentralizing the download location for other users. Downloading the image via zsync ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ zsync is a convenient application that will automatically verify the checksum of the image once downloaded. The Lubuntu team uses this to download daily images as it will seamlessly download the delta or difference since the last image was spun. In order to use zsync, you need to install it. Since this is a Linux-only client, you can get it from your distribution's package repository. If you are running Debian, Ubuntu, or a distribution based off of either, run the following command in a terminal: .. code:: sudo apt install zsync Otherwise, there is a snap application you can download of zsync which should function mostly the same and should work on all Linux distributions: .. code:: sudo snap install zsync To download the image using zsync run .. code:: zsync http://cdimage.ubuntu.com/lubuntu/releases/focal/release/lubuntu-20.04-desktop-amd64.iso.zsync **You have now downloaded the image successfully. Please continue to Chapter 1.2.** diff --git a/source/1/1.3/installation.rst b/source/1/1.3/installation.rst index 097bbe04..7337a419 100644 --- a/source/1/1.3/installation.rst +++ b/source/1/1.3/installation.rst @@ -1,88 +1,88 @@ Chapter 1.3 Installation ======================== -This is a guide to through the installation process of Lubuntu. +This is a guide through the installation process of Lubuntu. Starting the installer ---------------------- -Once you have booted the Lubuntu image, you will be greeted by a screen with the following options: :menuselection:`Start Lubuntu`, :menuselection:`Start Lubuntu (safe graphics)`, :menuselection:`Check disk for defects`, :menuselection:`Test memory`, and :menuselection:`Boot from first hard disk`. To start the install select :menuselection:`Start Lubuntu`, you will now be booting into a live session. If Lubuntu has trouble with your graphics card you can start the live session with :menuselection:`Start Lubuntu(safe graphics)`. The :menuselection:`Check disk for defects` option offers a way to check integrity of the disk image once it is burned to the media please use this if you have problems installing it could be bad media. The :menuselection:`Test memory` options test to make sure your RAM works on your computer. To switch your keyboard layout on the live session press :kbd:`F3` and select your keyboard layout. To bring back up the language selection press :kbd:`F2`. +Once you have booted the Lubuntu image, you will be greeted by a screen with the following options: :menuselection:`Start Lubuntu`, :menuselection:`Start Lubuntu (safe graphics)`, :menuselection:`Check disk for defects`, :menuselection:`Test memory`, and :menuselection:`Boot from first hard disk`. To start the install select :menuselection:`Start Lubuntu`, you will now be booting into a live session. If Lubuntu has trouble with your graphics card you can start the live session with :menuselection:`Start Lubuntu(safe graphics)`. The :menuselection:`Check disk for defects` option offers a way to check integrity of the disk-image once it is burned onto the install media (USB or DVD). Please use this if you have problems installing as it could be bad media. The :menuselection:`Test memory` option tests to make sure your RAM works on your computer. To switch your keyboard layout on the live session press :kbd:`F3` and select your keyboard layout. To bring back up the language selection press :kbd:`F2`. .. image:: boot_installer.png Once you have booted into the live session, feel free to explore Lubuntu and make sure all your hardware works. Once you are ready to install Lubuntu, double click the icon in the top-left corner of the desktop :guilabel:`Install Lubuntu 20.10`. .. image:: live_session.png You will be taken to the Lubuntu installer Welcome screen. You can change the installer language in the :guilabel:`Language` drop down box. After selecting the language the :guilabel:`Next` button will move you on to the next task. To cancel an installation press the :guilabel:`Cancel` button. .. image:: welcome_installer.png Selecting Your location ----------------------- The next screen will show you a map of the world where you can choose your location. Your location will be used to set your time zone and download server. To see what region you have chosen use the :guilabel:`Region` drop down menu. The :guilabel:`Zone` field should have a major city with the same time as you. On the bottom of the window there is a place to change your system language and to change this language press the :guilabel:`Change` button. To move to the next step once again press the :guilabel:`Next` button. To move back to selecting your language to change your language press the :guilabel:`Back` button. .. image:: location.png Selecting Keyboard Layout ------------------------- Next select your keyboard layout, you can check your keyboard matches the keyboard shown picture shown. At the bottom you can type to make sure your layout is correct. The :guilabel:`Keyboard Model` menu lets you choose different variants, the left column lets you change language, and the right column gets different variants. When you have selected your keyboard layout press the :guilabel:`Next` button to move on. .. image:: keyboard.png Setting up partitions --------------------- If all you want is Lubuntu on your machine, you can select the :guilabel:`Erase disk` button. This will format the disk and **delete all data on the disk**, which is why having your data backed up before this point is extremely important. If you choose to do this you can continue on to user setup. To change the storage device use the :guilabel:`Select Storage device` drop down menu. If you want to encrypt your drive press the :guilabel:`Encrypt system` checkbox and then you will need to enter the encryption passphrase twice make sure you have it typed in correctly. It is strongly advised to write down this passphrase and keep it somewhere safe. .. warning:: Erasing your entire disk or partition may cause you to lose data so please backup beforehand. .. image:: partitioning.png .. note:: If you had a previous Linux install with swap you will need to unmount the swap. To do this run .. code:: sudo swapoff -a which will unmount them and any swap partitions. This will not work if you have data partition mounted open PCManFM-Qt and press the upward pointed arrow on each partition in the :guilabel:`Places` sidebar to unmount all data partitions. To move back to Selecting your keyboard layout press the :guilabel:`Back` button. To advance to the setting up users press the :guilabel:`Next` button. User Setup ---------- The user setup section creates a user profile, consisting of typing your name into the :guilabel:`What is your name?` field. Next type your username in the :guilabel:`What name do you want to use to log in?`. Put what you want your hostname of your computer to be in the :guilabel:`what is the name of this computer?` field. The last thing you need to enter is your password in the :guilabel:`Choose a password to keep your account safe`. Enter your password twice to make sure you have not mistyped it. Pressing the :guilabel:`Next` button will give you a summary screen, showing you the settings before the install begins. Once you have checked the summary click the :guilabel:`Install` button to begin the installation. .. image:: user_setup.png After pressing the :guilabel:`Install` button a dialog will pop up to confirm installation. To actually install press the :guilabel:`Install now` button. To not start installing and go back press the :guilabel:`Go back` button. The Install ----------- The Lubuntu installer provides some useful information while the installer is running. On the bottom of the window is a progress bar. Once Lubuntu is installed you have a checkbox :guilabel:`Reboot now` after your Lubuntu is installed and is now finished. .. image:: installer_screen.png Manual partitioning ----------------------- -If you wish to manual set up partitions, as an advanced option you will have to choose which file-system you want. A file-system controls how your files are accessed at lower levels on the disk. If you are booting your computer in UEFI mode a more modern firmware compared to BIOS you will need to create an EFI system partition see `efi system partition Wikipedia `_ for more detail to create this partition you will need a FAT32 file-system with the ESP flag with to be mounted at /boot/efi/ under the mount point. You will also need a root (/) file-system, several file-systems included for Lubuntu are Ext4, XFS, and Btrfs. +If you wish to manual set up partitions, as an advanced option you will have to choose which file-system you want. A file-system controls how your files are accessed at lower levels on the disk. If you are booting your computer in UEFI mode a more modern firmware compared to BIOS you will need to create an EFI system partition (see `efi system partition Wikipedia `_ for more detail). To create this partition you will need a FAT32 file-system with the ESP flag to be mounted at /boot/efi/ under the mount point. You will also need a root (/) file-system, several file-systems included for Lubuntu are Ext4, XFS, and Btrfs. .. image:: manpartitioning.png If you have a new hard disc or solid state drive press the :guilabel:`New Partition table` button but this will delete the whole disc if you have any data on it. After pressing this button you will get a dialog saying what kind of partition table to use. The :guilabel:`Master Boot Record` button will create an old partition table but will only allow 4 primary partitions and partitions up to 2 Terabytes. The :guilabel:`GUID Partition Table` button works for large discs but may not be recognized by legacy other operating systems. To get back to your main partitioning window press the :guilabel:`OK` button. To change what disc you are partitioning use the :guilabel:`Storage device` drop down menu. You can create partition by clicking the :guilabel:`Create` button which will bring up a dialog. The file system field is a drop down menu, select which file-system you want. You also need to select where you want to mount the partition in the :guilabel:`Mount Point` drop down menu. To change how big to make the partition change the :guilabel:`Size` field. To change the size or type of a partition after initially creating it press the :guilabel:`Edit` button. To delete a partition press the :guilabel:`Delete` button. You will need at least one root (/) partition and if you are booting an EFI system you will also need a /boot/efi mounted partition. Another common option is to have all your data on its own partition, which can even be on its own separate physical disk this can be mounted at /home. If you want to encrypt your your filesystem press the :guilabel:`Encrypt` checkbox. Then a two fields will appear to get write type your encryption passphrase twice to confirm it. .. image:: manpartition-create.png To go back on all your changes to the previous state press the :guilabel:`Revert All Changes` button. To change what device your computer will boot off of you will need to use the :guilabel:`Install boot loader on` drop down menu to select which disc to boot off of. In the center of the manual partitioning window shows you what name of the partition is. What type of filesystem is displayed in the :guilabel:`File System` column. To see where your partition is mounted are shown in the :guilabel:`Mount Point` column. The size of the system is shown in the :guilabel:`Size` Column.