Maintenance Guides: Basic link clean up in advance of translation of content (#625) (#609)

* Basic link clean up in advance of translation of content

- Remove unused links
- Updated links  defined as named refs to use simple text e.g. name of linked content
instead of narrative text
- Minor edits to accomodate minor changes to name of ref links

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* Update links according to feedback on PR.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* Update link according to feedback on PR.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

Adds new figures for live-desktop, checking prerequisites, kernel options.

- Ref: https://github.com/clearlinux/clr-installer/issues/406
- Ref: https://github.com/clearlinux/clr-installer/issues/384

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Re-orders all figures; adds new section, advanced config as placeholder.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Re-scopes PR to include only checking prereqs, kernel update, and software update.
- Three new screenshots/figures

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Adds edits to bare-metal-install-desktop.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revise wording for Proxy configuration per new Network Manager.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Cleans up in-text reference to reordered figures.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Squash commit fake.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
This commit is contained in:
michael vincerra
2019-07-16 16:10:53 -07:00
committed by GitHub
parent 4f32e1995f
commit 676fc1fb37
10 changed files with 107 additions and 73 deletions
@@ -4,9 +4,9 @@ Install |CL-ATTR| from the live desktop
#######################################
The live desktop allows you to boot |CL-ATTR| in a GNOME desktop without
modifying the host system, offering the chance to explore developing
on |CL|. Better yet, launch the |CL| installer to install on your target
system.
modifying the host system, offering you the chance to explore developing
on |CL| or install it. In this document, we show how to install |CL| on a
target system.
.. contents:: :local:
:depth: 1
@@ -22,7 +22,10 @@ Assure that your target system supports the installation:
Preliminary steps
*****************
#. Visit our `Downloads`_ page and download the file :file:`clear-<release number>-live-desktop.iso`
#. `Visit our Downloads page`_.
#. Download the file :file:`clear-<release number>-live-desktop.iso`,
also called the |CL| Desktop.
.. note::
@@ -64,44 +67,8 @@ these steps.
.. _install-on-target-end:
Confirm network connection
==========================
Confirm there is a network connection before launching the installer.
Choose a method: `Wired Connection`, or `WiFi Connected`. This guide shows
an example of a **Wired Connection**.
#. In the upper right of the top menu bar, select the square icon to view
Network settings, shown in Figure 2.
#. Select :guilabel:`Wired Connected` and then :guilabel:`Wired Settings`.
.. figure:: figures/bare-metal-install-desktop-02.png
:scale: 100%
:alt: Software icon, Network settings
Figure 2: Software icon, Network settings
#. View the :guilabel:`Wired` menu to assure that you're target system and
installer are connected to a network.
#. Optional: Configure Proxy settings.
#. To view :guilabel:`Network Proxy`, select its :guilabel:`Gear` icon.
#. Select from `Automatic`, `Manual` or `Disabled` as desired.
#. Close the dialogue box.
#. Select the :guilabel:`Gear` icon to view Network settings.
#. If desired, select :guilabel:`Connect automatically`.
Select other options as desired.
#. Select :guilabel:`Apply` button to confirm change to settings.
Software (Optional)
-------------------
Software (optional)
===================
Explore |CL| bundles and other software. Double-click the
:guilabel:`Software` icon from the Activities menu, shown in Figure 2.
@@ -115,30 +82,62 @@ Assure a network connection exists before launching `Software`.
Launch the |CL| installer
=========================
#. After the live desktop image boots, find the |CL| installer icon in
the :guilabel:`Activities` menu at left, shown in Figure 3.
#. After the live desktop image boots, scroll over the vertical
:guilabel:`Activities` menu at left.
#. Click the |CL| penguin icon to launch the installer.
#. Click the |CL| penguin icon to launch the installer, shown in Figure 2.
.. figure:: figures/bare-metal-install-desktop-03.png
.. figure:: figures/bare-metal-install-desktop-02.png
:scale: 100%
:alt: Install Clear Linux OS icon
Figure 3: |CL| installer icon
Figure 2: |CL| installer icon
#. The installer is launched, as shown in Figure 4.
#. After the installer is launched, it will appear as shown in Figure 3.
.. figure:: figures/bare-metal-install-desktop-04.png
.. figure:: figures/bare-metal-install-desktop-03.png
:scale: 100%
:alt: |CL| Desktop Installer
Figure 4: |CL| OS Desktop Installer
Figure 3: |CL| OS Desktop Installer
#. In :guilabel:`Select Language`, select a language from the options, or
type your preferred language in the search bar.
#. Select :guilabel:`Next`.
Checking prerequisites
======================
The installer automatically launches :guilabel:`Checking Prerequisites`,
which checks your target system for compatibility and network connectivity.
After the installer shows `Prerequisites passed`, select :guilabel:`Next` to
proceed with installation.
.. figure:: figures/bare-metal-install-desktop-04.png
:scale: 100%
:alt: Checking Prerequisites
Figure 4: Checking Prerequisites
Network Proxy (optional)
------------------------
#. Configure :guilabel:`Network Proxy` settings.
#. In the top right menu bar, select the :guilabel:`Power button`.
#. Select :guilabel:`Wired Connected` and then :guilabel:`Wired Settings`.
#. In :guilabel:`Network Proxy`, select the :guilabel:`Gear` icon to view
options.
#. Select an option from `Automatic`, `Manual` or `Disabled`.
#. Close :guilabel:`Network Proxy`.
#. Close :guilabel:`Settings`.
.. _incl-bare-metal-beta-start:
@@ -153,7 +152,7 @@ To fulfill minimum installation requirements, complete the
* The :kbd:`Install` button is only highlighted **after** you complete
`Required options`_.
* Checkmarks indicate a selection has been made.
* Check marks indicate a selection has been made.
* An Internet connection is required. You may want to launch a browser
prior to installation to verify your Internet connection.
@@ -164,7 +163,7 @@ To fulfill minimum installation requirements, complete the
The |CL| Desktop Installer Main Menu appears as shown in Figure 5. To meet
the minimum requirements, enter values in all submenus for the
:guilabel:`Required options`. After you complete them, your selections appear
below submenus and a checkmark appears at right.
below submenus and a check mark appears at right.
.. figure:: figures/bare-metal-install-desktop-05.png
:scale: 100%
@@ -180,7 +179,7 @@ Navigation
* Use :kbd:`Tab` key to navigate between :guilabel:`Required options`
and :guilabel:`Advanced options`
* Use :kbd:`Up` or :kbd:`Down` arrow keys to navigate submenu list.
* Use :kbd:`Up` or :kbd:`Down` arrow keys to navigate the submenus.
* Select :kbd:`Confirm`, or :kbd:`Cancel` in submenus.
@@ -194,7 +193,7 @@ Select Time Zone
by default.
#. In :guilabel:`Select Time Zone`, navigate to the desired time zone.
Or start typing the region and then city.
Or start typing the region and then the city.
(.e.g., :file:`America/Los_Angeles`).
#. Select :guilabel:`Confirm`.
@@ -237,6 +236,7 @@ Select Installation Media
Safe Installation
-----------------
Use this method to safely install |CL| on media with available space, or
alongside existing partitions, and accept the `Default partition schema`_.
If enough free space exists, safe installation is allowed.
@@ -254,7 +254,8 @@ If enough free space exists, safe installation is allowed.
Destructive Installation
------------------------
Use this method to destroy the contents of the target device, install |CL| on it, and accept the `Default partition schema`_.
Use this method to destroy the contents of the target device, install |CL|
on it, and accept the `Default partition schema`_.
Disk encryption
===============
@@ -370,11 +371,9 @@ After you complete the `Required options`_, we recommend completing
customizes your development environment, so you're ready to go immediately
after reboot.
* `Bundle Selection`_
.. note::
* `Assign Hostname`_
As for bundles, you can always add more later with :ref:`swupd-guide`.
You can always add more bundles later with :ref:`swupd-guide`.
Bundle Selection
================
@@ -420,38 +419,73 @@ Assign Hostname
alphanumeric character but may also contain hyphens. Maximum length of
63 characters.
#. Navigate to :kbd:`Confirm` until highlighted.
#. Select :kbd:`Confirm`.
Optional: Skip to `Finish installation`_.
Kernel Configuration
====================
#. In :guilabel:`Kernel Configuration`, navigate to select your desired
kernel. :guilabel:`Native` is selected by default.
.. figure:: figures/bare-metal-install-desktop-16.png
:scale: 100%
:alt: Kernel Configuration
Figure 16: Kernel Configuration
#. To add arguments, enter the argument in :guilabel:`Add Extra Arguments`.
#. To remove an argument, enter the argument in :guilabel:`Remove Arguments`.
#. Select :kbd:`Confirm`.
Software Updater Configuration
==============================
#. In Advanced Options, select :guilabel:`Software Updater Configuration`.
#. In :guilabel:`Mirror URL`, follow the instructions if you wish to
specify a different installation source.
#. :guilabel:`Enable Auto Updates` is selected by default. If you **do not**
wish to enable automatic software updates, uncheck the box.
.. figure:: figures/bare-metal-install-desktop-17.png
:scale: 100%
:alt: Software Updater Configuration
Figure 17: Software Updater Configuration
#. Select :kbd:`Confirm`.
Finish installation
*******************
#. When you are satisfied with your installation configuration, select
:guilabel:`Install`.
.. figure:: figures/bare-metal-install-desktop-16.png
.. figure:: figures/bare-metal-install-desktop-18.png
:scale: 100%
:alt: Assign Hostname
Figure 16: Finish installation
Figure 18: Finish installation
.. note:
All checkmarks must be visible in :guilabel:`Required Options` for you to select :guilabel:`Install`.
All check marks must appear in :guilabel:`Required Options` for the
:guilabel:`Install` button to be enabled.
#. If you do not enter a selection for all :guilabel:`Required Options`,
the :guilabel:`Install` button remains greyed out, as shown
in Figure 17. Return to `Required Options`_ and make selections.
the :guilabel:`Install` button remains disabled, as shown
in Figure 19. Return to `Required Options`_ and make selections.
.. figure:: figures/bare-metal-install-desktop-17.png
.. figure:: figures/bare-metal-install-desktop-19.png
:scale: 100%
:alt: Required Options - Incomplete
Figure 17: Required Options - Incomplete
Figure 19: Required Options - Incomplete
#. After installation is complete, select :guilabel:`Exit`.
@@ -465,14 +499,14 @@ Finish installation
Allow time for the graphical login to appear. A login prompt shows the administrative user that you created.
#. Log in as the adminstrative user.
#. Log in as the administrative user.
Congratulations. You successfully installed |CL|.
Default partition schema
========================
Table 1 shows the defult partition schema with the exception of root,
Table 1 shows the default partition schema with the exception of root,
which varies.
.. list-table:: **Table 1. Disk Partition Setup**
@@ -497,6 +531,6 @@ Next steps
:ref:`guides`
.. _Downloads: https://clearlinux.org/downloads
.. _Autoproxy: https://clearlinux.org/features/autoproxy
.. _Visit our downloads page: https://clearlinux.org/downloads
Binary file not shown.

Before

Width:  |  Height:  |  Size: 196 KiB

After

Width:  |  Height:  |  Size: 189 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 196 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 189 KiB

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 92 KiB

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB