diff --git a/source/_figures/clear-lifecycle.png b/source/_figures/about/clear-lifecycle.png similarity index 100% rename from source/_figures/clear-lifecycle.png rename to source/_figures/about/clear-lifecycle.png diff --git a/source/tutorials/aws-web/figures/aws-web-1.png b/source/_figures/aws/aws-web-1.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-1.png rename to source/_figures/aws/aws-web-1.png diff --git a/source/tutorials/aws-web/figures/aws-web-10.png b/source/_figures/aws/aws-web-10.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-10.png rename to source/_figures/aws/aws-web-10.png diff --git a/source/tutorials/aws-web/figures/aws-web-11.png b/source/_figures/aws/aws-web-11.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-11.png rename to source/_figures/aws/aws-web-11.png diff --git a/source/tutorials/aws-web/figures/aws-web-12.png b/source/_figures/aws/aws-web-12.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-12.png rename to source/_figures/aws/aws-web-12.png diff --git a/source/tutorials/aws-web/figures/aws-web-13.png b/source/_figures/aws/aws-web-13.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-13.png rename to source/_figures/aws/aws-web-13.png diff --git a/source/tutorials/aws-web/figures/aws-web-14.png b/source/_figures/aws/aws-web-14.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-14.png rename to source/_figures/aws/aws-web-14.png diff --git a/source/tutorials/aws-web/figures/aws-web-2.png b/source/_figures/aws/aws-web-2.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-2.png rename to source/_figures/aws/aws-web-2.png diff --git a/source/tutorials/aws-web/figures/aws-web-3.png b/source/_figures/aws/aws-web-3.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-3.png rename to source/_figures/aws/aws-web-3.png diff --git a/source/tutorials/aws-web/figures/aws-web-4.png b/source/_figures/aws/aws-web-4.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-4.png rename to source/_figures/aws/aws-web-4.png diff --git a/source/tutorials/aws-web/figures/aws-web-5.png b/source/_figures/aws/aws-web-5.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-5.png rename to source/_figures/aws/aws-web-5.png diff --git a/source/tutorials/aws-web/figures/aws-web-6.png b/source/_figures/aws/aws-web-6.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-6.png rename to source/_figures/aws/aws-web-6.png diff --git a/source/tutorials/aws-web/figures/aws-web-7.png b/source/_figures/aws/aws-web-7.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-7.png rename to source/_figures/aws/aws-web-7.png diff --git a/source/tutorials/aws-web/figures/aws-web-8.png b/source/_figures/aws/aws-web-8.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-8.png rename to source/_figures/aws/aws-web-8.png diff --git a/source/tutorials/aws-web/figures/aws-web-9.png b/source/_figures/aws/aws-web-9.png similarity index 100% rename from source/tutorials/aws-web/figures/aws-web-9.png rename to source/_figures/aws/aws-web-9.png diff --git a/source/tutorials/azure/figures/azure-1.png b/source/_figures/azure/azure-1.png similarity index 100% rename from source/tutorials/azure/figures/azure-1.png rename to source/_figures/azure/azure-1.png diff --git a/source/tutorials/azure/figures/azure-2.png b/source/_figures/azure/azure-2.png similarity index 100% rename from source/tutorials/azure/figures/azure-2.png rename to source/_figures/azure/azure-2.png diff --git a/source/tutorials/azure/figures/azure-3.png b/source/_figures/azure/azure-3.png similarity index 100% rename from source/tutorials/azure/figures/azure-3.png rename to source/_figures/azure/azure-3.png diff --git a/source/tutorials/flatpak/figures/01-install-libreoffice.gif b/source/_figures/flatpak/01-install-libreoffice.gif similarity index 100% rename from source/tutorials/flatpak/figures/01-install-libreoffice.gif rename to source/_figures/flatpak/01-install-libreoffice.gif diff --git a/source/tutorials/flatpak/figures/02-openlibreoffice.gif b/source/_figures/flatpak/02-openlibreoffice.gif similarity index 100% rename from source/tutorials/flatpak/figures/02-openlibreoffice.gif rename to source/_figures/flatpak/02-openlibreoffice.gif diff --git a/source/tutorials/smb/figures/smb-1.png b/source/_figures/samba/smb-1.png similarity index 100% rename from source/tutorials/smb/figures/smb-1.png rename to source/_figures/samba/smb-1.png diff --git a/source/tutorials/smb/figures/smb-2.png b/source/_figures/samba/smb-2.png similarity index 100% rename from source/tutorials/smb/figures/smb-2.png rename to source/_figures/samba/smb-2.png diff --git a/source/tutorials/smb/figures/smb-desktop-1.png b/source/_figures/samba/smb-desktop-1.png similarity index 100% rename from source/tutorials/smb/figures/smb-desktop-1.png rename to source/_figures/samba/smb-desktop-1.png diff --git a/source/tutorials/smb/figures/smb-desktop-2.png b/source/_figures/samba/smb-desktop-2.png similarity index 100% rename from source/tutorials/smb/figures/smb-desktop-2.png rename to source/_figures/samba/smb-desktop-2.png diff --git a/source/tutorials/smb/figures/smb-desktop-3.png b/source/_figures/samba/smb-desktop-3.png similarity index 100% rename from source/tutorials/smb/figures/smb-desktop-3.png rename to source/_figures/samba/smb-desktop-3.png diff --git a/source/guides/telemetrics/figures/telemetry-backend-1.png b/source/_figures/telemetrics/telemetry-backend-1.png similarity index 100% rename from source/guides/telemetrics/figures/telemetry-backend-1.png rename to source/_figures/telemetrics/telemetry-backend-1.png diff --git a/source/guides/telemetrics/figures/telemetry-e2e.png b/source/_figures/telemetrics/telemetry-e2e.png similarity index 100% rename from source/guides/telemetrics/figures/telemetry-e2e.png rename to source/_figures/telemetrics/telemetry-e2e.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-1.png b/source/_figures/tensorflow/machine-learning-1.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-1.png rename to source/_figures/tensorflow/machine-learning-1.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-2.png b/source/_figures/tensorflow/machine-learning-2.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-2.png rename to source/_figures/tensorflow/machine-learning-2.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-3.png b/source/_figures/tensorflow/machine-learning-3.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-3.png rename to source/_figures/tensorflow/machine-learning-3.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-4.png b/source/_figures/tensorflow/machine-learning-4.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-4.png rename to source/_figures/tensorflow/machine-learning-4.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-5.png b/source/_figures/tensorflow/machine-learning-5.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-5.png rename to source/_figures/tensorflow/machine-learning-5.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-6.png b/source/_figures/tensorflow/machine-learning-6.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-6.png rename to source/_figures/tensorflow/machine-learning-6.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-7.png b/source/_figures/tensorflow/machine-learning-7.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-7.png rename to source/_figures/tensorflow/machine-learning-7.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-8.png b/source/_figures/tensorflow/machine-learning-8.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-8.png rename to source/_figures/tensorflow/machine-learning-8.png diff --git a/source/tutorials/machine-learning/figures/run-cell-button.png b/source/_figures/tensorflow/run-cell-button.png similarity index 100% rename from source/tutorials/machine-learning/figures/run-cell-button.png rename to source/_figures/tensorflow/run-cell-button.png diff --git a/source/tutorials/wordpress/figures/web-server-install-1.png b/source/_figures/wordpress/web-server-install-1.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-1.png rename to source/_figures/wordpress/web-server-install-1.png diff --git a/source/tutorials/wordpress/figures/web-server-install-2.png b/source/_figures/wordpress/web-server-install-2.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-2.png rename to source/_figures/wordpress/web-server-install-2.png diff --git a/source/tutorials/wordpress/figures/web-server-install-3.png b/source/_figures/wordpress/web-server-install-3.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-3.png rename to source/_figures/wordpress/web-server-install-3.png diff --git a/source/tutorials/wordpress/figures/web-server-install-4.png b/source/_figures/wordpress/web-server-install-4.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-4.png rename to source/_figures/wordpress/web-server-install-4.png diff --git a/source/tutorials/wordpress/figures/web-server-install-5.png b/source/_figures/wordpress/web-server-install-5.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-5.png rename to source/_figures/wordpress/web-server-install-5.png diff --git a/source/tutorials/wordpress/figures/web-server-install-6.png b/source/_figures/wordpress/web-server-install-6.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-6.png rename to source/_figures/wordpress/web-server-install-6.png diff --git a/source/tutorials/wordpress/figures/web-server-install-7.png b/source/_figures/wordpress/web-server-install-7.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-7.png rename to source/_figures/wordpress/web-server-install-7.png diff --git a/source/tutorials/wordpress/figures/web-server-install-8.png b/source/_figures/wordpress/web-server-install-8.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-8.png rename to source/_figures/wordpress/web-server-install-8.png diff --git a/source/tutorials/wordpress/figures/wp-install-1.png b/source/_figures/wordpress/wp-install-1.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-1.png rename to source/_figures/wordpress/wp-install-1.png diff --git a/source/tutorials/wordpress/figures/wp-install-2.png b/source/_figures/wordpress/wp-install-2.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-2.png rename to source/_figures/wordpress/wp-install-2.png diff --git a/source/tutorials/wordpress/figures/wp-install-3.png b/source/_figures/wordpress/wp-install-3.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-3.png rename to source/_figures/wordpress/wp-install-3.png diff --git a/source/tutorials/wordpress/figures/wp-install-4.png b/source/_figures/wordpress/wp-install-4.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-4.png rename to source/_figures/wordpress/wp-install-4.png diff --git a/source/tutorials/wordpress/figures/wp-install-5.png b/source/_figures/wordpress/wp-install-5.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-5.png rename to source/_figures/wordpress/wp-install-5.png diff --git a/source/tutorials/wordpress/figures/wp-install-6.png b/source/_figures/wordpress/wp-install-6.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-6.png rename to source/_figures/wordpress/wp-install-6.png diff --git a/source/tutorials/wordpress/figures/wp-install-7.png b/source/_figures/wordpress/wp-install-7.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-7.png rename to source/_figures/wordpress/wp-install-7.png diff --git a/source/tutorials/wordpress/figures/wp-install-8.png b/source/_figures/wordpress/wp-install-8.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-8.png rename to source/_figures/wordpress/wp-install-8.png diff --git a/source/_images/favicon.ico b/source/_images/favicon.ico new file mode 100644 index 00000000..73c917b1 Binary files /dev/null and b/source/_images/favicon.ico differ diff --git a/source/about.rst b/source/about.rst index 63bc1f06..c79bf3f4 100644 --- a/source/about.rst +++ b/source/about.rst @@ -56,7 +56,7 @@ The same tools used to build the |CL| are available *in* the OS. These tools can be used to create a custom distribution that continues to benefit from upstream rolling releases. -.. figure:: /_figures/clear-lifecycle.png +.. figure:: /_figures/about/clear-lifecycle.png :scale: 75% :align: center :alt: Creating and managing a Clear Linux* OS version (or derivative) diff --git a/source/concepts/telemetry-about.rst b/source/concepts/telemetry-about.rst index 34a12d1e..ecab4ec9 100644 --- a/source/concepts/telemetry-about.rst +++ b/source/concepts/telemetry-about.rst @@ -42,7 +42,7 @@ Architecture If you want to capture your own records for analysis, you must set up your own backend server. -.. figure:: ../guides/telemetrics/figures/telemetry-e2e.png +.. figure:: /_figures/telemetrics/telemetry-e2e.png :scale: 75% :alt: Clear Linux Telemetry Architecture. diff --git a/source/conf.py b/source/conf.py index 33fcd32e..7782b40c 100644 --- a/source/conf.py +++ b/source/conf.py @@ -168,7 +168,7 @@ html_logo = '_images/clearlinux.png' # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +html_favicon = '_images/favicon.ico' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/source/tutorials/aws-web/aws-web.rst b/source/get-started/cloud-install/aws-web.rst similarity index 93% rename from source/tutorials/aws-web/aws-web.rst rename to source/get-started/cloud-install/aws-web.rst index b4de082e..2c4f0d53 100644 --- a/source/tutorials/aws-web/aws-web.rst +++ b/source/get-started/cloud-install/aws-web.rst @@ -41,7 +41,7 @@ Locate, select, and launch the |CL| Basic AMI #. Start from your main AWS services console menu in your browser and select the :guilabel:`EC2` text as shown in Figure 1: - .. figure:: figures/aws-web-1.png + .. figure:: /_figures/aws/aws-web-1.png :scale: 50 % :alt: AWS Console @@ -52,7 +52,7 @@ Locate, select, and launch the |CL| Basic AMI #. To create a new |CL| instance from the :guilabel:`EC2 Dashboard` menu, select the :guilabel:`Launch Instance` button as shown in Figure 2: - .. figure:: figures/aws-web-2.png + .. figure:: /_figures/aws/aws-web-2.png :scale: 50 % :alt: EC2 Dashboard @@ -75,7 +75,7 @@ Locate, select, and launch the |CL| Basic AMI #. Select the :guilabel:`Clear Linux OS Basic` AMI by clicking the :guilabel:`Select` button as shown in Figure 3: - .. figure:: figures/aws-web-3.png + .. figure:: /_figures/aws/aws-web-3.png :scale: 50 % :alt: Step 1: Choose AMI @@ -86,7 +86,7 @@ Locate, select, and launch the |CL| Basic AMI running |CL| on different platform configurations as shown in Figure 4. Select the :guilabel:`Continue` button. - .. figure:: figures/aws-web-4.png + .. figure:: /_figures/aws/aws-web-4.png :scale: 50 % :alt: Clear Linux OS Basic @@ -94,7 +94,7 @@ Locate, select, and launch the |CL| Basic AMI #. The :guilabel:`Choose Instance Type` menu appears as shown in Figure 5. - .. figure:: figures/aws-web-5.png + .. figure:: /_figures/aws/aws-web-5.png :scale: 50 % :alt: Choose an Instance Type @@ -116,7 +116,7 @@ Locate, select, and launch the |CL| Basic AMI the :guilabel:`Previous` screen to change the configuration or :guilabel:`Launch` the instance defined. - .. figure:: figures/aws-web-6.png + .. figure:: /_figures/aws/aws-web-6.png :scale: 50 % :alt: Step 7: Review the Instance Launch @@ -126,7 +126,7 @@ Locate, select, and launch the |CL| Basic AMI Figure 7, asking you to :guilabel:`Select an existing key pair or create a new pair`. - .. figure:: figures/aws-web-7.png + .. figure:: /_figures/aws/aws-web-7.png :scale: 50 % :alt: Select an existing key pair or create a new pair @@ -144,7 +144,7 @@ Locate, select, and launch the |CL| Basic AMI :guilabel:`Launch Instances` button to proceed to the :guilabel:`Launch Status` menu shown in Figure 8. - .. figure:: figures/aws-web-8.png + .. figure:: /_figures/aws/aws-web-8.png :scale: 50 % :alt: Launch Status @@ -154,7 +154,7 @@ Locate, select, and launch the |CL| Basic AMI Figure 9, select the :guilabel:`View Instances` button to view your :guilabel:`Instances` dashboard. - .. figure:: figures/aws-web-9.png + .. figure:: /_figures/aws/aws-web-9.png :scale: 50 % :alt: View Instance @@ -167,7 +167,7 @@ Your :guilabel:`Instances` Dashboard is shown in Figure 10 with the new |CL| OS basic instance already selected and in the running state. If there are other instances available, they are also listed but not selected. -.. figure:: figures/aws-web-10.png +.. figure:: /_figures/aws/aws-web-10.png :scale: 50 % :alt: Instance Dashboard @@ -179,7 +179,7 @@ other instances available, they are also listed but not selected. .. _fig-aws-web-11: -.. figure:: figures/aws-web-11.png +.. figure:: /_figures/aws/aws-web-11.png :scale: 50 % :alt: Connect to Your Instance @@ -235,7 +235,7 @@ Update the |CL| instance Run the :command:`sudo swupd update` command to update the operating system as shown in Figure 12: -.. figure:: figures/aws-web-12.png +.. figure:: /_figures/aws/aws-web-12.png :scale: 50 % :alt: sudo swupd update @@ -259,7 +259,7 @@ instance from running. Figure 13 illustrates these steps. - .. figure:: figures/aws-web-13.png + .. figure:: /_figures/aws/aws-web-13.png :scale: 50 % :alt: Stop Instance @@ -269,7 +269,7 @@ instance from running. your instance will be lost. Select the :guilabel:`Yes, Stop` button to stop your |CL| instance. -.. figure:: figures/aws-web-14.png +.. figure:: /_figures/aws/aws-web-14.png :scale: 50 % :alt: Stop Instances diff --git a/source/tutorials/azure.rst b/source/get-started/cloud-install/azure.rst similarity index 99% rename from source/tutorials/azure.rst rename to source/get-started/cloud-install/azure.rst index 82f3f319..98483a10 100644 --- a/source/tutorials/azure.rst +++ b/source/get-started/cloud-install/azure.rst @@ -269,7 +269,7 @@ Log into your Microsoft Azure account #. Open your browser and enter the page `https://aka.ms/devicelogin` as shown in figure 1: - .. figure:: azure/figures/azure-1.png + .. figure:: /_figures/azure/azure-1.png :scale: 50 % :alt: Microsoft Device Login @@ -280,7 +280,7 @@ Log into your Microsoft Azure account session login and will be different each time you log into MS Azure using the :command:`az login` command. - .. figure:: azure/figures/azure-2.png + .. figure:: /_figures/azure/azure-2.png :scale: 50 % :alt: Microsoft Device Login - Azure CLI @@ -294,7 +294,7 @@ Log into your Microsoft Azure account have signed into the Microsoft Cross-platform Command Line Interface application on your device and you can close the window. - .. figure:: azure/figures/azure-3.png + .. figure:: /_figures/azure/azure-3.png :scale: 50 % :alt: Microsoft Azure Cross-platform CLI diff --git a/source/get-started/index.rst b/source/get-started/index.rst index a0ff24fd..6527f9d0 100644 --- a/source/get-started/index.rst +++ b/source/get-started/index.rst @@ -46,4 +46,13 @@ Install in a virtual machine :glob: virtual-machine-install/* - ../../guides/maintenance/increase-virtual-disk-size.rst \ No newline at end of file + ../../guides/maintenance/increase-virtual-disk-size.rst + +Deploy to the cloud +******************** + +.. toctree:: + :maxdepth: 1 + :glob: + + cloud-install/* \ No newline at end of file diff --git a/source/guides/clear/swupd-guide.rst b/source/guides/clear/swupd.rst similarity index 100% rename from source/guides/clear/swupd-guide.rst rename to source/guides/clear/swupd.rst diff --git a/source/guides/telemetrics/telem-guide.rst b/source/guides/clear/telemetrics.rst similarity index 99% rename from source/guides/telemetrics/telem-guide.rst rename to source/guides/clear/telemetrics.rst index aa68b3aa..1e302ed2 100644 --- a/source/guides/telemetrics/telem-guide.rst +++ b/source/guides/clear/telemetrics.rst @@ -66,7 +66,7 @@ Architecture * Backend: receives records sent from the client and displays the cumulative content through a specialized web interface. -.. figure:: figures/telemetry-e2e.png +.. figure:: /_figures/telemetrics/telemetry-e2e.png :alt: Figure 1, Telemetry Architecture Figure 1: :guilabel:`|CL| Telemetry Architecture` @@ -368,7 +368,7 @@ using the :ref:`bare-metal-install-server` getting started guide and: in the address bar. You should see a web page similar to the one shown in Figure 2 below. - .. figure:: figures/telemetry-backend-1.png + .. figure:: /_figures/telemetrics/telemetry-backend-1.png :alt: Telemetry UI Figure 2: :guilabel:`Telemetry UI` diff --git a/source/guides/index.rst b/source/guides/index.rst index 38d63b65..3700d8a0 100644 --- a/source/guides/index.rst +++ b/source/guides/index.rst @@ -19,7 +19,6 @@ Clear Linux :glob: clear/* - telemetrics/* Maintenance =========== @@ -29,7 +28,6 @@ Maintenance :glob: maintenance/* - deploy-at-scale Network ======= diff --git a/source/guides/deploy-at-scale.rst b/source/guides/maintenance/deploy-at-scale.rst similarity index 100% rename from source/guides/deploy-at-scale.rst rename to source/guides/maintenance/deploy-at-scale.rst diff --git a/source/guides/telemetrics/figures/telemetry-backend-2.png b/source/guides/telemetrics/figures/telemetry-backend-2.png deleted file mode 100644 index 08c0f812..00000000 Binary files a/source/guides/telemetrics/figures/telemetry-backend-2.png and /dev/null differ diff --git a/source/tutorials/hadoop.rst b/source/tutorials/apache-hadoop.rst similarity index 97% rename from source/tutorials/hadoop.rst rename to source/tutorials/apache-hadoop.rst index 633c84d5..7f443891 100644 --- a/source/tutorials/hadoop.rst +++ b/source/tutorials/apache-hadoop.rst @@ -1,10 +1,10 @@ .. _hadoop: -Set up a single node cluster with Hadoop\* -########################################## +Apache\* Hadoop\* +################# This tutorial walks you through the process of installing, configuring, and -running Apache\* Hadoop on |CL-ATTR|. The Apache Hadoop software library is a +running Apache Hadoop on |CL-ATTR|. The Apache Hadoop software library is a framework for distributed processing of large data sets across clusters of computers using simple programming models. It is designed to scale up from single servers to thousands of machines, with each machine offering local diff --git a/source/tutorials/spark.rst b/source/tutorials/apache-spark.rst similarity index 97% rename from source/tutorials/spark.rst rename to source/tutorials/apache-spark.rst index 2f0d22ab..0624fd5b 100644 --- a/source/tutorials/spark.rst +++ b/source/tutorials/apache-spark.rst @@ -1,7 +1,7 @@ .. _spark: -Set up a standalone cluster system using Apache\* Spark\* -######################################################### +Apache\* Spark\* +################ This tutorial describes how to install, configure, and run Apache Spark on |CL-ATTR|. Apache Spark is a fast general-purpose cluster computing system with diff --git a/source/tutorials/kata_migration.rst b/source/tutorials/archive/kata_migration.rst similarity index 100% rename from source/tutorials/kata_migration.rst rename to source/tutorials/archive/kata_migration.rst diff --git a/source/tutorials/docker/docker.rst b/source/tutorials/docker.rst similarity index 99% rename from source/tutorials/docker/docker.rst rename to source/tutorials/docker.rst index 2c885f77..8d646c2c 100644 --- a/source/tutorials/docker/docker.rst +++ b/source/tutorials/docker.rst @@ -1,7 +1,7 @@ .. _docker: -Run Docker\* on |CL-ATTR| -######################### +Docker\* +######### |CL-ATTR| supports multiple containerization platforms, including a Docker solution. |CL| has many unique features including a minimal default diff --git a/source/tutorials/flatpak/flatpak.rst b/source/tutorials/flatpak.rst similarity index 91% rename from source/tutorials/flatpak/flatpak.rst rename to source/tutorials/flatpak.rst index 1ca74e39..c186dc00 100644 --- a/source/tutorials/flatpak/flatpak.rst +++ b/source/tutorials/flatpak.rst @@ -1,7 +1,7 @@ .. _flatpak: -Use Flatpak\* to install applications on |CL-ATTR| -################################################## +Flatpak\* +######### This tutorial provides all the required steps to install Flatpak as well as downloading, installing, and running LibreOffice\* on |CL-ATTR|. @@ -43,7 +43,7 @@ Installing using gnome software All you need to do is to launch `gnome software`, search for the LibreOffice app, and click the install button. -.. figure:: figures/01-install-libreoffice.gif +.. figure:: /_figures/flatpak/01-install-libreoffice.gif :alt: install libreoffice step by step Figure 1: Installing LibreOffice using gnome-software @@ -81,7 +81,7 @@ A new set of icons will appear in your Gnome applications list titled :guilabel: execute the application, highlight the application and click on the :guilabel:`LibreOffice` icon. LibreOffice will start normally. -.. figure:: figures/02-openlibreoffice.gif +.. figure:: /_figures/flatpak/02-openlibreoffice.gif :alt: Opening LibreOffice app Figure 2: Select :guilabel:`LibreOffice` app diff --git a/source/tutorials/fmv.rst b/source/tutorials/fmv.rst index 2b31bde1..9b2853f0 100644 --- a/source/tutorials/fmv.rst +++ b/source/tutorials/fmv.rst @@ -1,7 +1,7 @@ .. _fmv: -Use the function multi-version patch generator -############################################## +Function multi-versioning +######################### CPU architectures often gain interesting new instructions as they evolve but application developers find it difficult to take advantage of those diff --git a/source/tutorials/index.rst b/source/tutorials/index.rst index 48f78344..7ec9665a 100644 --- a/source/tutorials/index.rst +++ b/source/tutorials/index.rst @@ -9,21 +9,15 @@ Explore our tutorials to discover what you can do with |CL|! :maxdepth: 1 :glob: - wordpress/wordpress - flatpak/flatpak - machine-learning/machine-learning - docker/docker - azure - hadoop - fmv - aws-web/aws-web - smb/smb* - spark - kata - kata_migration - kubernetes/kubernetes* - yubikey-u2f - nvidia - nvidia-cuda - redis - tutorial-proxy + * + +Archive +******* + +Older tutorials that may still be relevant to some users. + +.. toctree:: + :maxdepth: 1 + :glob: + + archive/* \ No newline at end of file diff --git a/source/tutorials/kata.rst b/source/tutorials/kata.rst index 7f4863fc..23c8eb4a 100644 --- a/source/tutorials/kata.rst +++ b/source/tutorials/kata.rst @@ -1,7 +1,7 @@ .. _kata: -Install Kata Containers\* -######################### +Kata Containers\* +################# This tutorial describes how to install, configure, and run `Kata Containers`_ on |CL-ATTR|. diff --git a/source/tutorials/kubernetes/kubernetes-bp.rst b/source/tutorials/kubernetes-bp.rst similarity index 98% rename from source/tutorials/kubernetes/kubernetes-bp.rst rename to source/tutorials/kubernetes-bp.rst index a7126e2b..757f4515 100644 --- a/source/tutorials/kubernetes/kubernetes-bp.rst +++ b/source/tutorials/kubernetes-bp.rst @@ -1,7 +1,7 @@ .. _kubernetes-bp: -Kubernetes Best Practices on |CL| -################################# +Kubernetes\* Best Practices +########################### Use swupd to update clusters **************************** diff --git a/source/tutorials/kubernetes/kubernetes.rst b/source/tutorials/kubernetes.rst similarity index 99% rename from source/tutorials/kubernetes/kubernetes.rst rename to source/tutorials/kubernetes.rst index 93c8d68c..8fc7b841 100644 --- a/source/tutorials/kubernetes/kubernetes.rst +++ b/source/tutorials/kubernetes.rst @@ -1,7 +1,7 @@ .. _kubernetes: -Run Kubernetes\* -################ +Kubernetes\* +############ This tutorial describes how to install, configure, and run the `Kubernetes container orchestration system`_ on |CL-ATTR| using CRI+O and diff --git a/source/tutorials/nvidia-cuda.rst b/source/tutorials/nvidia-cuda.rst index c3735b53..aa056c1a 100644 --- a/source/tutorials/nvidia-cuda.rst +++ b/source/tutorials/nvidia-cuda.rst @@ -1,7 +1,7 @@ .. _nvidia-cuda: -Install NVIDIA CUDA Toolkit -########################### +NVIDIA\* CUDA Toolkit +##################### NVIDIA is a manufacturer of graphics processing units (GPU), also known as graphics cards. diff --git a/source/tutorials/nvidia.rst b/source/tutorials/nvidia.rst index 5473bed9..b1be1d8d 100644 --- a/source/tutorials/nvidia.rst +++ b/source/tutorials/nvidia.rst @@ -1,7 +1,7 @@ .. _nvidia: -Install NVIDIA\* Drivers -######################## +NVIDIA\* Drivers +################ NVIDIA manufactures graphics processing units (GPU), also known as graphics cards. diff --git a/source/tutorials/tutorial-proxy.rst b/source/tutorials/proxy.rst similarity index 98% rename from source/tutorials/tutorial-proxy.rst rename to source/tutorials/proxy.rst index b538dd66..d266f77d 100644 --- a/source/tutorials/tutorial-proxy.rst +++ b/source/tutorials/proxy.rst @@ -1,7 +1,7 @@ .. _tutorial-proxy: -Setting up proxy -################ +Proxy configuration +################### This tutorial shows you how to configure your system for use behind an outbound proxy to access the Internet. diff --git a/source/tutorials/redis.rst b/source/tutorials/redis.rst index 1d86e4c9..3e4addb1 100644 --- a/source/tutorials/redis.rst +++ b/source/tutorials/redis.rst @@ -1,7 +1,7 @@ .. _redis: -Run Redis on |CL-ATTR| -###################### +Redis\* +####### Redis is an in-memory key:value store designed for quick lookups, accessible over the network. In this tutorial, you'll install redis and launch a diff --git a/source/tutorials/smb/smb-desktop.rst b/source/tutorials/smb-desktop.rst similarity index 88% rename from source/tutorials/smb/smb-desktop.rst rename to source/tutorials/smb-desktop.rst index efa4c260..08f3da9b 100644 --- a/source/tutorials/smb/smb-desktop.rst +++ b/source/tutorials/smb-desktop.rst @@ -1,7 +1,7 @@ .. _smb-desktop: -Connect to Windows\* shared location from |CL-ATTR| desktop -########################################################### +Samba\* as a client +################### This tutorial explains how to access an existing shared drive on Windows\* via Server Message Block (SMB) / Common Internet File System (CIFS) @@ -24,7 +24,7 @@ Connect to Windows shared location with Nautilus #. In :guilabel:`Files`, select :guilabel:`Other Locations`. - .. figure:: figures/smb-desktop-1.png + .. figure:: /_figures/samba/smb-desktop-1.png :scale: 100% :alt: Files, Other Locations @@ -37,7 +37,7 @@ Connect to Windows shared location with Nautilus smb://servername/Share - .. figure:: figures/smb-desktop-2.png + .. figure:: /_figures/samba/smb-desktop-2.png :scale: 100% :alt: Connect to Server @@ -61,7 +61,7 @@ Connect to Windows shared location with Nautilus #. The server will request authentication, as shown in Figure 3. - .. figure:: figures/smb-desktop-3.png + .. figure:: /_figures/samba/smb-desktop-3.png :scale: 100% :alt: Authentication diff --git a/source/tutorials/smb/smb.rst b/source/tutorials/smb.rst similarity index 95% rename from source/tutorials/smb/smb.rst rename to source/tutorials/smb.rst index a2892d22..8ccf1259 100644 --- a/source/tutorials/smb/smb.rst +++ b/source/tutorials/smb.rst @@ -1,7 +1,7 @@ .. _clear-samba-share-to-Windows: -Enable simple file sharing with a Windows\* machine using Samba\* -################################################################# +Samba\* as a host +################# This tutorial describes how to enable simple file sharing from a system running |CL-ATTR| to a Windows machine using Samba. For more advanced sharing, @@ -109,7 +109,7 @@ Map |CL| drive in Windows the Samba user `clearlinuxuser` and the password created with :command:`smbpasswd`. See Figure 1 for details. - .. figure:: figures/smb-1.png + .. figure:: /_figures/samba/smb-1.png :scale: 70% :alt: Map a network drive in Windows Explorer @@ -117,7 +117,7 @@ Map |CL| drive in Windows When complete, Windows Explorer displays the share drive as shown in Figure 2. -.. figure:: figures/smb-2.png +.. figure:: /_figures/samba/smb-2.png :scale: 70% :alt: View a share drive in Windows Explorer diff --git a/source/tutorials/machine-learning/machine-learning.rst b/source/tutorials/tensorflow-machine-learning.rst similarity index 92% rename from source/tutorials/machine-learning/machine-learning.rst rename to source/tutorials/tensorflow-machine-learning.rst index de491bb7..745a56d1 100644 --- a/source/tutorials/machine-learning/machine-learning.rst +++ b/source/tutorials/tensorflow-machine-learning.rst @@ -1,7 +1,7 @@ .. _machine-learning: -TensorFlow\* machine learning on |CL-ATTR| -########################################## +TensorFlow\* machine learning +############################# This tutorial demonstrates the installation and execution of a TensorFlow\* machine learning example on |CL-ATTR|. It uses a Jupyter\* Notebook and MNIST @@ -111,7 +111,7 @@ run the example code. manager with a list of files in the current directory, as shown in Figure 1. - .. figure:: figures/machine-learning-1.png + .. figure:: /_figures/tensorflow/machine-learning-1.png :alt: Jupyter file manager Figure 1: The Jupyter file manager shows the list of available files. @@ -119,7 +119,7 @@ run the example code. #. Click on the :file:`Handwriting` directory. The :file:`MNIST_example.ipynb` file created earlier should be listed there, as shown in Figure 2. - .. figure:: figures/machine-learning-2.png + .. figure:: /_figures/tensorflow/machine-learning-2.png :alt: Example file within the Jupyter file manager Figure 2: The example file within the Jupyter file manager. @@ -127,7 +127,7 @@ run the example code. #. To run the handwriting example, click on the :file:`MNIST_example.ipynb` file to load the notebook, as shown in Figure 3. - .. figure:: figures/machine-learning-3.png + .. figure:: /_figures/tensorflow/machine-learning-3.png :alt: The loaded MNIST_example notebook Figure 3: The loaded MNIST_example notebook within the Jupyter file @@ -139,7 +139,7 @@ run the example code. #. Select the :guilabel:`In [2]` cell and click the |run-cell| button to load the MNIST data. The successful output is shown on Figure 4. - .. figure:: figures/machine-learning-4.png + .. figure:: /_figures/tensorflow/machine-learning-4.png :alt: Successful import of MNIST data Figure 4: Output after successfully importing the MNIST data. @@ -156,7 +156,7 @@ run the example code. the first two digits in the `trainX` dataset. An example is shown in Figure 5. - .. figure:: figures/machine-learning-5.png + .. figure:: /_figures/tensorflow/machine-learning-5.png :alt: Function to reshape data. Figure 5: A function reshapes the data and displays the first two @@ -167,7 +167,7 @@ run the example code. the output layer, as shown in Figure 6. Click the |run-cell| button four times to perform these operations. - .. figure:: figures/machine-learning-6.png + .. figure:: /_figures/tensorflow/machine-learning-6.png :alt: Defining, building and training the neural network model Figure 6: Defining, building, and training the neural network model. @@ -176,7 +176,7 @@ run the example code. :guilabel:`In [8]` cell and click the |run-cell| button. In this example, the number 6 was predicted with a 99% accuracy, as shown in Figure 7. - .. figure:: figures/machine-learning-7.png + .. figure:: /_figures/tensorflow/machine-learning-7.png :alt: Prediction example Figure 7: The system predicts a number providing the accuracy of the @@ -192,7 +192,7 @@ run the example code. cell and click the |run-cell| button. Our example's accuracy is calculated as 97.17%, as shown in Figure 8. - .. figure:: figures/machine-learning-8.png + .. figure:: /_figures/tensorflow/machine-learning-8.png :alt: System's accuracy Figure 8: The system's accuracy for the entire data set. @@ -245,4 +245,4 @@ Related topics .. _MNIST at Wikipedia: https://en.wikipedia.org/wiki/MNIST_database -.. |run-cell| image:: ./figures/run-cell-button.png +.. |run-cell| image:: /_figures/tensorflow/run-cell-button.png diff --git a/source/tutorials/wordpress/wordpress.rst b/source/tutorials/wordpress.rst similarity index 86% rename from source/tutorials/wordpress/wordpress.rst rename to source/tutorials/wordpress.rst index 6eecac79..da6c9c03 100644 --- a/source/tutorials/wordpress/wordpress.rst +++ b/source/tutorials/wordpress.rst @@ -1,7 +1,7 @@ .. _wordpress: -WordPress\* on |CL-ATTR| -######################## +WordPress\* +########### This tutorial describes how to setup a web server to host a WordPress\* site on a |CL-ATTR| system. The tutorial is split into two sections: @@ -23,5 +23,5 @@ you can skip ahead to the second section of this tutorial. :maxdepth: 1 :hidden: - web-server-install.rst - wp-install.rst + wordpress/web-server-install.rst + wordpress/wp-install.rst diff --git a/source/tutorials/wordpress/web-server-install.rst b/source/tutorials/wordpress/web-server-install.rst index 268754ee..bd5de10b 100644 --- a/source/tutorials/wordpress/web-server-install.rst +++ b/source/tutorials/wordpress/web-server-install.rst @@ -60,7 +60,7 @@ Apache software bundle on |CL|. If the service is running, a confirmation message will appear, similar to the message shown in figure 1. - .. figure:: figures/web-server-install-1.png + .. figure:: /_figures/wordpress/web-server-install-1.png :alt: This web server is operational from host. :scale: 50% @@ -225,7 +225,7 @@ functionality to your web server, install PHP on your system. #. Verify that the PHP information screen appears, similar to figure 2: - .. figure:: figures/web-server-install-2.png + .. figure:: /_figures/wordpress/web-server-install-2.png :alt: PHP information screen :width: 600 @@ -415,7 +415,7 @@ steps below for setting up a database called "WordPress". :ref:`mysql_secure_installation command `. Enter your credentials and select :guilabel:`Go` to log in: - .. figure:: figures/web-server-install-3.png + .. figure:: /_figures/wordpress/web-server-install-3.png :alt: phpMyAdmin login page :width: 600 @@ -424,7 +424,7 @@ steps below for setting up a database called "WordPress". #. Verify a successful login by confirming that the main phpMyAdmin page displays, as shown in figure 4: - .. figure:: figures/web-server-install-4.png + .. figure:: /_figures/wordpress/web-server-install-4.png :alt: phpMyAdmin dashboard :width: 600 @@ -441,7 +441,7 @@ steps below for setting up a database called "WordPress". #. Click :guilabel:`Create`. - .. figure:: figures/web-server-install-5.png + .. figure:: /_figures/wordpress/web-server-install-5.png :alt: Databases tab :width: 600 @@ -452,7 +452,7 @@ steps below for setting up a database called "WordPress". #. Select the :guilabel:`Privileges` tab. Figure 6 shows its contents. - .. figure:: figures/web-server-install-6.png + .. figure:: /_figures/wordpress/web-server-install-6.png :alt: Privileges tab :width: 600 @@ -462,7 +462,7 @@ steps below for setting up a database called "WordPress". :guilabel:`Privileges` tab. The `Add user account` page appears, as shown in figure 7. - .. figure:: figures/web-server-install-7.png + .. figure:: /_figures/wordpress/web-server-install-7.png :alt: User accounts tab :width: 600 @@ -484,7 +484,7 @@ steps below for setting up a database called "WordPress". If successful, you should see the screen shown in figure 8: -.. figure:: figures/web-server-install-8.png +.. figure:: /_figures/wordpress/web-server-install-8.png :alt: User added successfully :width: 600 diff --git a/source/tutorials/wordpress/wp-install.rst b/source/tutorials/wordpress/wp-install.rst index 9a0a2d0f..e5fcd1eb 100644 --- a/source/tutorials/wordpress/wp-install.rst +++ b/source/tutorials/wordpress/wp-install.rst @@ -92,7 +92,7 @@ The WordPress language option screen appears, as shown in figure 1. #. Select :guilabel:`English` and click :guilabel:`Continue`. - .. figure:: figures/wp-install-1.png + .. figure:: /_figures/wordpress/wp-install-1.png :alt: WordPress language selection :width: 600 @@ -102,7 +102,7 @@ The WordPress language option screen appears, as shown in figure 1. The WordPress installation continues until the Welcome screen appears, as shown in figure 2: - .. figure:: figures/wp-install-2.png + .. figure:: /_figures/wordpress/wp-install-2.png :alt: WordPress welcome screen :width: 600 @@ -119,7 +119,7 @@ The WordPress language option screen appears, as shown in figure 1. * Database host: localhost * Table prefix: wp\_ - .. figure:: figures/wp-install-3.png + .. figure:: /_figures/wordpress/wp-install-3.png :alt: Database connection details :width: 600 @@ -130,7 +130,7 @@ The WordPress language option screen appears, as shown in figure 1. Figure 4 shows the confirmation screen that verifies a successful setup. WordPress is connected to the MariaDB database. - .. figure:: figures/wp-install-4.png + .. figure:: /_figures/wordpress/wp-install-4.png :alt: Successful database connection. :width: 600 @@ -145,7 +145,7 @@ Complete successful login Once the installation is complete, you can name your blog and create a WordPress username and password. See figure 5. -.. figure:: figures/wp-install-5.png +.. figure:: /_figures/wordpress/wp-install-5.png :alt: WordPress user creation :width: 600 @@ -156,7 +156,7 @@ and password. See figure 5. #. Click :guilabel:`Install WordPress`. #. Verify that the initial login screen appears once the installation is complete. See figure 6: - .. figure:: figures/wp-install-6.png + .. figure:: /_figures/wordpress/wp-install-6.png :alt: WordPress login :width: 600 @@ -168,7 +168,7 @@ and password. See figure 5. Figure 7 shows the WordPress dashboard after a successful login: -.. figure:: figures/wp-install-7.png +.. figure:: /_figures/wordpress/wp-install-7.png :alt: WordPress Dashboard :width: 600 @@ -179,7 +179,7 @@ You are ready to go! To check out your blog as it is seen by the outside world, enter: \http:///blog on your browser. Figure 8 shows the result: -.. figure:: figures/wp-install-8.png +.. figure:: /_figures/wordpress/wp-install-8.png :alt: WordPress blog :width: 600 diff --git a/source/tutorials/yubikey-u2f.rst b/source/tutorials/yubikey-u2f.rst index 59401efe..db61e0a0 100644 --- a/source/tutorials/yubikey-u2f.rst +++ b/source/tutorials/yubikey-u2f.rst @@ -1,7 +1,7 @@ .. _yubikey-u2f: -Enable YubiKey U2F Support -########################## +YubiKey\* Support +################# YubiKey\* is a USB security token manufactured by `Yubico`_. Depending on the model, a YubiKey can support different authentication protocols including: