diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index c93851df..995586cf 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -4,7 +4,7 @@ pages: script: - apk --no-cache add python3 - python3 -m ensurepip - - pip3 install sphinx==1.7.5 docutils==0.14 sphinx_rtd_theme breathe==4.9.1 sphinxcontrib-plantuml sphinx-intl==2.0.0 + - pip3 install sphinx==1.8.0 docutils==0.14 sphinx_rtd_theme breathe==4.9.1 sphinxcontrib-plantuml sphinx-intl==2.0.0 sphinx-sitemap==1.0.2 - apk --no-cache add make - apk --no-cache add doxygen - apk --no-cache add graphviz diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-01.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-01.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-01.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-01.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-02.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-02.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-02.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-02.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-02X.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-02X.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-02X.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-02X.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-03.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-03.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-03.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-03.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-04.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-04.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-04.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-04.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-05.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-05.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-05.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-05.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-06.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-06.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-06.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-06.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-07.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-07.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-07.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-07.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-08.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-08.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-08.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-08.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-09.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-09.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-09.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-09.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-10.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-10.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-10.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-10.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-11.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-11.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-11.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-11.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-12.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-12.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-12.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-12.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-13.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-13.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-13.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-13.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-14.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-14.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-14.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-14.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-15.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-15.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-15.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-15.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-16.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-16.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-16.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-16.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-17.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-17.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-17.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-17.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-18.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-18.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-18.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-18.png diff --git a/source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-19.png b/source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-19.png similarity index 100% rename from source/get-started/bare-metal-install-desktop/figures/bare-metal-install-desktop-19.png rename to source/_figures/bare-metal-install-desktop/bare-metal-install-desktop-19.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-01.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-01.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-01.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-01.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-02.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-02.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-02.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-02.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-03.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-03.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-03.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-03.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-04.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-04.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-04.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-04.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-05.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-05.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-05.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-05.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-06.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-06.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-06.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-06.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-07.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-07.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-07.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-07.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-08.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-08.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-08.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-08.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-09.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-09.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-09.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-09.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-10.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-10.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-10.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-10.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-11.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-11.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-11.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-11.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-12.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-12.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-12.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-12.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-13.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-13.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-13.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-13.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-14.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-14.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-14.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-14.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-15.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-15.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-15.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-15.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-16.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-16.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-16.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-16.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-17.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-17.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-17.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-17.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-18.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-18.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-18.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-18.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-19.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-19.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-19.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-19.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-20.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-20.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-20.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-20.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-21.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-21.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-21.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-21.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-22.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-22.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-22.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-22.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-23.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-23.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-23.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-23.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-24.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-24.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-24.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-24.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-25.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-25.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-25.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-25.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-26.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-26.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-26.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-26.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-27.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-27.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-27.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-27.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-28.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-28.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-28.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-28.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-29.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-29.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-29.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-29.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-30.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-30.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-30.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-30.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-31.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-31.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-31.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-31.png diff --git a/source/get-started/bare-metal-install-server/figures/bare-metal-install-server-32.png b/source/_figures/bare-metal-install-server/bare-metal-install-server-32.png similarity index 100% rename from source/get-started/bare-metal-install-server/figures/bare-metal-install-server-32.png rename to source/_figures/bare-metal-install-server/bare-metal-install-server-32.png diff --git a/source/conf.py b/source/conf.py index 7782b40c..3774c142 100644 --- a/source/conf.py +++ b/source/conf.py @@ -139,7 +139,7 @@ html_context = { "display_github": True, # Integrate GitHub "github_user": "clearlinux", # Username "github_repo": "clear-linux-documentation", # Repo name - "github_version": "rtd-theme", # Version + "github_version": "master", # Version "conf_py_path": "/source/", # Path in the checkout to the docs root "current_version": current_version, "languages": ( ("English", "/clearlinux/latest"), diff --git a/source/get-started/bare-metal-install-desktop/bare-metal-install-desktop.rst b/source/get-started/bare-metal-install-desktop.rst similarity index 88% rename from source/get-started/bare-metal-install-desktop/bare-metal-install-desktop.rst rename to source/get-started/bare-metal-install-desktop.rst index 25d1ada5..5ba5f841 100644 --- a/source/get-started/bare-metal-install-desktop/bare-metal-install-desktop.rst +++ b/source/get-started/bare-metal-install-desktop.rst @@ -63,7 +63,7 @@ these steps. #. Select :guilabel:`Clear Linux OS` in the boot menu, shown in Figure 1. - .. figure:: figures/bare-metal-install-desktop-01.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-01.png :scale: 100% :alt: Clear Linux OS in boot menu @@ -92,7 +92,7 @@ Launch the |CL| installer #. Click the |CL| penguin icon to launch the installer, shown in Figure 2. - .. figure:: figures/bare-metal-install-desktop-02.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-02.png :scale: 100% :alt: Install Clear Linux OS icon @@ -100,7 +100,7 @@ Launch the |CL| installer #. After the installer is launched, it will appear as shown in Figure 3. - .. figure:: figures/bare-metal-install-desktop-03.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-03.png :scale: 100% :alt: |CL| Desktop Installer @@ -120,7 +120,7 @@ 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 +.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-04.png :scale: 100% :alt: Checking Prerequisites @@ -170,7 +170,7 @@ the minimum requirements, enter values in all submenus for the :guilabel:`Required options`. After you complete them, your selections appear below submenus and a check mark appears at right. -.. figure:: figures/bare-metal-install-desktop-05.png +.. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-05.png :scale: 100% :alt: Clear Linux OS Desktop Installer - Main Menu @@ -203,7 +203,7 @@ Select Time Zone #. Select :guilabel:`Confirm`. - .. figure:: figures/bare-metal-install-desktop-06.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-06.png :scale: 100% :alt: Select System Timezone @@ -219,7 +219,7 @@ Select Keyboard #. Select :guilabel:`Confirm`. - .. figure:: figures/bare-metal-install-desktop-07.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-07.png :scale: 100% :alt: Select Keyboard menu @@ -233,7 +233,7 @@ Select Installation Media #. Choose an installation method: `Safe Installation`_ or `Destructive Installation`_. - .. figure:: figures/bare-metal-install-desktop-08.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-08.png :scale: 100% :alt: Select Installation Media @@ -271,7 +271,7 @@ optional. #. To encrypt the root partition, select :guilabel:`Enable Encryption`, as shown in Figure 9. - .. figure:: figures/bare-metal-install-desktop-09.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-09.png :scale: 100% :alt: Enable Encryption @@ -279,7 +279,7 @@ optional. #. When :guilabel:`Encryption Passphrase` appears, enter a passphrase. - .. figure:: figures/bare-metal-install-desktop-10.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-10.png :scale: 100% :alt: Encryption Passphrase @@ -306,7 +306,7 @@ Manage User #. In :guilabel:`User Name`, enter a user name. - .. figure:: figures/bare-metal-install-desktop-11.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-11.png :scale: 100% :alt: Manage User @@ -360,7 +360,7 @@ team for improvements. For more information, see :ref:`telemetry-about`. #. Select :kbd:`Yes`. - .. figure:: figures/bare-metal-install-desktop-12.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-12.png :scale: 100% :alt: Enable Telemetry @@ -387,7 +387,7 @@ Bundle Selection #. Select your desired bundles. - .. figure:: figures/bare-metal-install-desktop-13.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-13.png :scale: 100% :alt: Bundle Selection @@ -397,7 +397,7 @@ Bundle Selection #. View the bundles that you selected. - .. figure:: figures/bare-metal-install-desktop-14.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-14.png :scale: 100% :alt: Bundle Selections - Advanced Options @@ -412,7 +412,7 @@ Assign Hostname #. In :guilabel:`Hostname`, enter the hostname only (excluding the domain). - .. figure:: figures/bare-metal-install-desktop-15.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-15.png :scale: 100% :alt: Assign Hostname @@ -434,7 +434,7 @@ 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 + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-16.png :scale: 100% :alt: Kernel Configuration @@ -457,7 +457,7 @@ Software Updater Configuration #. :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 + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-17.png :scale: 100% :alt: Software Updater Configuration @@ -471,7 +471,7 @@ Finish installation #. When you are satisfied with your installation configuration, select :guilabel:`Install`. - .. figure:: figures/bare-metal-install-desktop-18.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-18.png :scale: 100% :alt: Assign Hostname @@ -486,7 +486,7 @@ Finish installation the :guilabel:`Install` button remains disabled, as shown in Figure 19. Return to `Required Options`_ and make selections. - .. figure:: figures/bare-metal-install-desktop-19.png + .. figure:: /_figures/bare-metal-install-desktop/bare-metal-install-desktop-19.png :scale: 100% :alt: Required Options - Incomplete diff --git a/source/get-started/bare-metal-install-server/bare-metal-install-server.rst b/source/get-started/bare-metal-install-server.rst similarity index 88% rename from source/get-started/bare-metal-install-server/bare-metal-install-server.rst rename to source/get-started/bare-metal-install-server.rst index 7e0225de..c0076482 100644 --- a/source/get-started/bare-metal-install-server/bare-metal-install-server.rst +++ b/source/get-started/bare-metal-install-server.rst @@ -67,7 +67,7 @@ Follow these steps to install |CL| on the target system: #. This action launches the |CL| installer boot menu, shown in figure 1. - .. figure:: figures/bare-metal-install-server-01.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-01.png :scale: 100% :alt: Clear Linux OS Installer boot menu @@ -83,7 +83,7 @@ Launch the |CL| Installer #. Follow the onscreen instructions, shown in Figure 2, and enter a temporary password. - .. figure:: figures/bare-metal-install-server-02.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-02.png :scale: 100% :alt: root login @@ -92,7 +92,7 @@ Launch the |CL| Installer #. At the :guilabel:`root` prompt, enter :command:`clr-installer` and press :kbd:`Enter`. - .. figure:: figures/bare-metal-install-server-03.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-03.png :scale: 100% :alt: clr-installer command @@ -114,7 +114,7 @@ Main Menu ********* The |CL| Installer Main Menu appears as shown in Figure 4. -.. figure:: figures/bare-metal-install-server-04.png +.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-04.png :scale: 100% :alt: Clear Linux OS Installer @@ -158,7 +158,7 @@ Choose Timezone #. Press :kbd:`Enter` to confirm. - .. figure:: figures/bare-metal-install-server-05.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-05.png :scale: 100% :alt: Select System Timezone @@ -175,7 +175,7 @@ Choose Language #. Press :kbd:`Enter` to confirm. - .. figure:: figures/bare-metal-install-server-06.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-06.png :scale: 100% :alt: Select System Language @@ -195,7 +195,7 @@ Configure the Keyboard #. Optional: In :guilabel:`Test keyboard`, type text to assure that the keys map to your keyboard. - .. figure:: figures/bare-metal-install-server-07.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-07.png :scale: 100% :alt: Select Keyboard menu @@ -212,7 +212,7 @@ Configure Installation Media * `Advanced Configuration`_ - .. figure:: figures/bare-metal-install-server-08.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-08.png :scale: 100% :alt: Select Installation Media @@ -260,7 +260,7 @@ configuration of each partition. #. In :guilabel:`Advanced Configuration`, navigate to :file:`/dev/sda` and then press :kbd:`Enter`. - .. figure:: figures/bare-metal-install-server-09.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-09.png :scale: 100% :alt: Advanced configuration menu @@ -299,7 +299,7 @@ root partition #. We configure the `root` partition as shown in Figure 10. Configuration of the `root` partition varies. - .. figure:: figures/bare-metal-install-server-10.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-10.png :scale: 100% :alt: root partition @@ -312,7 +312,7 @@ boot partition #. We configure the `boot` partition as shown in Figure 11. - .. figure:: figures/bare-metal-install-server-11.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-11.png :scale: 100% :alt: boot partition @@ -326,7 +326,7 @@ swap partition #. In the :guilabel:`File System` pulldown menu, select `swap`, and enter a label. We enter the minimum required size (e.g., 256M). - .. figure:: figures/bare-metal-install-server-12.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-12.png :scale: 100% :alt: swap partition @@ -339,7 +339,7 @@ swap partition Manual partitioning is complete. - .. figure:: figures/bare-metal-install-server-13.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-13.png :scale: 100% :alt: Final configuration of disk partitions @@ -363,7 +363,7 @@ be configured post-installation using the ``cryptsetup`` tool. #. Optional: Select :guilabel:`[X] Encrypt` to encrypt the root partition, as shown in Figure 14. - .. figure:: figures/bare-metal-install-server-14.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-14.png :scale: 100% :alt: Encrypt partition @@ -375,7 +375,7 @@ be configured post-installation using the ``cryptsetup`` tool. Minimum length is 8 characters. Maximum length is 94 characters. - .. figure:: figures/bare-metal-install-server-15.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-15.png :scale: 100% :alt: Encryption Passphrase @@ -405,7 +405,7 @@ Select your desired option on whether to participate in `telemetry`. #. Select :kbd:`Enter` to confirm. - .. figure:: figures/bare-metal-install-server-16.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-16.png :scale: 100% :alt: Enable Telemetry @@ -455,7 +455,7 @@ interface settings are automatically applied. .. note:: Multiple network interfaces may appear. - .. figure:: figures/bare-metal-install-server-17.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-17.png :scale: 100% :alt: Configure Network Interfaces @@ -466,7 +466,7 @@ interface settings are automatically applied. Optional: Navigate to the checkbox :guilabel:`Automatic / dhcp` and select :kbd:`Spacebar` to deselect. - .. figure:: figures/bare-metal-install-server-18.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-18.png :scale: 100% :alt: Network interface configuration @@ -506,7 +506,7 @@ instruction. #. Navigate to the field :guilabel:`HTTPS Proxy`. - .. figure:: figures/bare-metal-install-server-19.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-19.png :scale: 100% :alt: Configure the network proxy @@ -530,7 +530,7 @@ select :guilabel:`Test Network Settings` and select :guilabel:`Enter`. A progress bar appears as shown in Figure 20. -.. figure:: figures/bare-metal-install-server-20.png +.. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-20.png :scale: 100% :alt: Testing Networking dialogue @@ -552,7 +552,7 @@ Bundle Selection #. Select :kbd:`Spacebar` to select the checkbox for each desired bundle. - .. figure:: figures/bare-metal-install-server-21.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-21.png :scale: 100% :alt: Bundle Selection @@ -577,7 +577,7 @@ Add New User #. Select :guilabel:`Add New User` as shown in Figure 22. - .. figure:: figures/bare-metal-install-server-22.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-22.png :scale: 100% :alt: Add New User, User Name @@ -589,7 +589,7 @@ Add New User The User Name must be alphanumeric and can include spaces, commas, or hyphens. Maximum length is 64 characters. - .. figure:: figures/bare-metal-install-server-23.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-23.png :scale: 100% :alt: User Name @@ -634,7 +634,7 @@ Modify / Delete User #. Select :kbd:`Enter` to modify the user. - .. figure:: figures/bare-metal-install-server-24.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-24.png :scale: 100% :alt: Modify User @@ -653,7 +653,7 @@ Modify / Delete User #. Optional: In :guilabel:`Modify User`, to delete the user, navigate to the :guilabel:`Delete` button and select :kbd:`Enter`. - .. figure:: figures/bare-metal-install-server-25.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-25.png :scale: 100% :alt: Delete User @@ -680,7 +680,7 @@ new kernel. #. Select :kbd:`Enter`. - .. figure:: figures/bare-metal-install-server-26.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-26.png :scale: 100% :alt: kernel command line @@ -705,7 +705,7 @@ Kernel Selection #. To select a different kernel, navigate to it using :guilabel:`Tab`. - .. figure:: figures/bare-metal-install-server-27.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-27.png :scale: 100% :alt: Kernel selection @@ -728,7 +728,7 @@ If you have your own custom mirror of |CL|, you can add its URL. #. Select :kbd:`Confirm`. - .. figure:: figures/bare-metal-install-server-28.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-28.png :scale: 100% :alt: Swupd Mirror @@ -749,7 +749,7 @@ Assign Hostname alphanumeric character but may also contain hyphens. Maximum length of 63 characters. - .. figure:: figures/bare-metal-install-server-29.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-29.png :scale: 100% :alt: Assign Hostname @@ -772,7 +772,7 @@ shown in Figure 30. #. Select the desired option. - .. figure:: figures/bare-metal-install-server-30.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-30.png :scale: 100% :alt: Automatic OS Updates @@ -788,7 +788,7 @@ Save Configuration Settings #. A dialogue box shows the installation configuration was saved to :file:`clr-installer.yaml` - .. figure:: figures/bare-metal-install-server-31.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-31.png :scale: 100% :alt: Automatic OS Updates @@ -803,7 +803,7 @@ Finish installation #. When you are satisfied with your installation configuration, navigate to :guilabel:`Install` and select :kbd:`Enter`. - .. figure:: figures/bare-metal-install-server-32.png + .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-32.png :scale: 100% :alt: Select Install diff --git a/source/get-started/index.rst b/source/get-started/index.rst index 6527f9d0..4c11ca9b 100644 --- a/source/get-started/index.rst +++ b/source/get-started/index.rst @@ -32,8 +32,8 @@ Install .. toctree:: :maxdepth: 1 - bare-metal-install-desktop/bare-metal-install-desktop - bare-metal-install-server/bare-metal-install-server + bare-metal-install-desktop + bare-metal-install-server install-configfile .. _virtual-machine-install: diff --git a/source/get-started/virtual-machine-install/figures/vmw-player/vmw-player-09.png b/source/get-started/virtual-machine-install/figures/vmw-player/vmw-player-09.png index 0644ac29..1eba9c88 100644 Binary files a/source/get-started/virtual-machine-install/figures/vmw-player/vmw-player-09.png and b/source/get-started/virtual-machine-install/figures/vmw-player/vmw-player-09.png differ diff --git a/source/get-started/virtual-machine-install/figures/vmw-player/vmw-player-10.png b/source/get-started/virtual-machine-install/figures/vmw-player/vmw-player-10.png index 4f6687c7..0644ac29 100644 Binary files a/source/get-started/virtual-machine-install/figures/vmw-player/vmw-player-10.png and b/source/get-started/virtual-machine-install/figures/vmw-player/vmw-player-10.png differ diff --git a/source/get-started/virtual-machine-install/figures/vmw-player/vmw-player-11.png b/source/get-started/virtual-machine-install/figures/vmw-player/vmw-player-11.png index 1eba9c88..4f6687c7 100644 Binary files a/source/get-started/virtual-machine-install/figures/vmw-player/vmw-player-11.png and b/source/get-started/virtual-machine-install/figures/vmw-player/vmw-player-11.png differ diff --git a/source/get-started/virtual-machine-install/vmw-player.rst b/source/get-started/virtual-machine-install/vmw-player.rst index a1028274..75f6fed7 100644 --- a/source/get-started/virtual-machine-install/vmw-player.rst +++ b/source/get-started/virtual-machine-install/vmw-player.rst @@ -190,55 +190,18 @@ Create and configure a new VM #. Click the :guilabel:`Finish` button. -Install |CL| into the new VM -**************************** - -#. Select the newly-created VM and click the :guilabel:`Play virtual machine` - button. See Figure 9. - - .. figure:: figures/vmw-player/vmw-player-09.png - :scale: 100% - :alt: VMware Workstation Player - Power on virtual machine - - Figure 9: VMware Workstation Player - Power on virtual machine - -#. Follow the :ref:`install-on-target-start` guide to complete the - installation of |CL|. - -#. After the installation completes, reboot the VM. This reboot restarts the - |CL| installer. - -Detach the |CL| installer ISO from the VM -***************************************** - -#. To enable the mouse pointer so you access VMware Workstation Player's - menus, press :kbd:`` + :kbd:`` on the keyboard. - -#. To disconnect the CD/DVD to stop it from booting the |CL| installer ISO - again, click the :guilabel:`Player` menu. See Figure 10. - - .. figure:: figures/vmw-player/vmw-player-10.png - :scale: 100% - :alt: VMware Workstation Player - Edit CD/DVD settings - - Figure 10: VMware Workstation Player - Edit CD/DVD settings - -#. Go to :menuselection:`Removable Devices-->CD/DVD (IDE)-->Disconnect`. - -#. Click the :guilabel:`OK` button. - Enable UEFI boot support ************************ |CL| needs UEFI support to boot. To enable UEFI: -#. Power off the VM. click the :guilabel:`Player` menu. See Figure 11. +#. Power off the VM. click the :guilabel:`Player` menu. See Figure 9. - .. figure:: figures/vmw-player/vmw-player-11.png + .. figure:: figures/vmw-player/vmw-player-09.png :scale: 100% :alt: VMware Workstation Player - Power off virtual machine - Figure 11: VMware Workstation Player - Power off virtual machine + Figure 9: VMware Workstation Player - Power off virtual machine #. Go to :guilabel:`Power` and select :guilabel:`Shut Down Guest`. @@ -255,24 +218,64 @@ Enable UEFI boot support * On Linux distros: :file:`/home/username/vmware` * On Windows: :file:`C:\\Users\\username\\Documents\\Virtual Machines` +Install |CL| into the new VM +**************************** -#. After configuring the settings above, power on your |CL| virtual machine. - On the :guilabel:`VMware Workstation Player` home screen, select your - VM. See Figure 9. +#. Select the newly-created VM and click the :guilabel:`Play virtual machine` + button. See Figure 10. + + .. figure:: figures/vmw-player/vmw-player-10.png + :scale: 100% + :alt: VMware Workstation Player - Power on virtual machine + + Figure 10: VMware Workstation Player - Power on virtual machine + +#. Follow the :ref:`install-on-target-start` guide to complete the + installation of |CL|. + +#. After the installation completes, reboot the VM. This reboot restarts the + |CL| installer. + +Detach the |CL| installer ISO from the VM +***************************************** + +#. To enable the mouse pointer so you access VMware Workstation Player's + menus, press :kbd:`` + :kbd:`` on the keyboard. + +#. To disconnect the CD/DVD to stop it from booting the |CL| installer ISO + again, click the :guilabel:`Player` menu. See Figure 11. + + .. figure:: figures/vmw-player/vmw-player-11.png + :scale: 100% + :alt: VMware Workstation Player - Edit CD/DVD settings + + Figure 11: VMware Workstation Player - Edit CD/DVD settings + +#. Go to :menuselection:`Removable Devices-->CD/DVD (IDE)-->Disconnect`. + +#. Click the :guilabel:`OK` button. + +Install open-vm-tools +********************* + +Optional: You may want to install the `open-vm-tools` in your virtual +machine. The Open Virtual Machine Tools (open-vm-tools) are the open source +implementation of VMware Tools for Linux\* guest operating systems. + +#. Power on your |CL| virtual machine. On the + :guilabel:`VMware Workstation Player` home screen, select your VM. See Figure 10. #. Click :guilabel:`Play virtual machine`. -#. Install Open VM Tools. You may want to install the `open-vm-tools` in - your virtual machine. The Open Virtual Machine Tools (open-vm-tools) are - the open source implementation of VMware Tools for Linux guest operating - systems. In |CL| you can use the following to install the bundle in your VM +#. In |CL| you can install the bundle, and enable the tools, in your VM. - .. code-block:: console + .. code-block:: bash sudo swupd bundle-add os-cloudguest-vmware sudo systemctl enable --now open-vm-tools -More information is available on the `VMWare Tools Product Documentation`_ site. +More information is available on the `VMWare Tools Product Documentation`_ +site. Related topics ************** diff --git a/source/guides/maintenance/fix-broken-install.rst b/source/guides/maintenance/fix-broken-install.rst index 33765b89..5515b697 100644 --- a/source/guides/maintenance/fix-broken-install.rst +++ b/source/guides/maintenance/fix-broken-install.rst @@ -32,7 +32,7 @@ Boot a live desktop image to fix target system #. Boot the |CL| live desktop image. -.. include:: ../../get-started/bare-metal-install-desktop/bare-metal-install-desktop.rst +.. include:: ../../get-started/bare-metal-install-desktop.rst :start-after: install-on-target-start: :end-before: install-on-target-end: