diff --git a/source/tutorials/flatpak/figures/01-install-libreoffice.gif b/source/_figures/01-install-libreoffice.gif similarity index 100% rename from source/tutorials/flatpak/figures/01-install-libreoffice.gif rename to source/_figures/01-install-libreoffice.gif diff --git a/source/tutorials/flatpak/figures/02-openlibreoffice.gif b/source/_figures/02-openlibreoffice.gif similarity index 100% rename from source/tutorials/flatpak/figures/02-openlibreoffice.gif rename to source/_figures/02-openlibreoffice.gif diff --git a/source/tutorials/machine-learning/figures/machine-learning-1.png b/source/_figures/machine-learning-1.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-1.png rename to source/_figures/machine-learning-1.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-2.png b/source/_figures/machine-learning-2.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-2.png rename to source/_figures/machine-learning-2.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-3.png b/source/_figures/machine-learning-3.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-3.png rename to source/_figures/machine-learning-3.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-4.png b/source/_figures/machine-learning-4.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-4.png rename to source/_figures/machine-learning-4.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-5.png b/source/_figures/machine-learning-5.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-5.png rename to source/_figures/machine-learning-5.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-6.png b/source/_figures/machine-learning-6.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-6.png rename to source/_figures/machine-learning-6.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-7.png b/source/_figures/machine-learning-7.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-7.png rename to source/_figures/machine-learning-7.png diff --git a/source/tutorials/machine-learning/figures/machine-learning-8.png b/source/_figures/machine-learning-8.png similarity index 100% rename from source/tutorials/machine-learning/figures/machine-learning-8.png rename to source/_figures/machine-learning-8.png diff --git a/source/tutorials/machine-learning/figures/run-cell-button.png b/source/_figures/run-cell-button.png similarity index 100% rename from source/tutorials/machine-learning/figures/run-cell-button.png rename to source/_figures/run-cell-button.png diff --git a/source/tutorials/smb/figures/smb-1.png b/source/_figures/smb-1.png similarity index 100% rename from source/tutorials/smb/figures/smb-1.png rename to source/_figures/smb-1.png diff --git a/source/tutorials/smb/figures/smb-2.png b/source/_figures/smb-2.png similarity index 100% rename from source/tutorials/smb/figures/smb-2.png rename to source/_figures/smb-2.png diff --git a/source/tutorials/smb/figures/smb-desktop-1.png b/source/_figures/smb-desktop-1.png similarity index 100% rename from source/tutorials/smb/figures/smb-desktop-1.png rename to source/_figures/smb-desktop-1.png diff --git a/source/tutorials/smb/figures/smb-desktop-2.png b/source/_figures/smb-desktop-2.png similarity index 100% rename from source/tutorials/smb/figures/smb-desktop-2.png rename to source/_figures/smb-desktop-2.png diff --git a/source/tutorials/smb/figures/smb-desktop-3.png b/source/_figures/smb-desktop-3.png similarity index 100% rename from source/tutorials/smb/figures/smb-desktop-3.png rename to source/_figures/smb-desktop-3.png diff --git a/source/tutorials/wordpress/figures/web-server-install-1.png b/source/_figures/web-server-install-1.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-1.png rename to source/_figures/web-server-install-1.png diff --git a/source/tutorials/wordpress/figures/web-server-install-2.png b/source/_figures/web-server-install-2.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-2.png rename to source/_figures/web-server-install-2.png diff --git a/source/tutorials/wordpress/figures/web-server-install-3.png b/source/_figures/web-server-install-3.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-3.png rename to source/_figures/web-server-install-3.png diff --git a/source/tutorials/wordpress/figures/web-server-install-4.png b/source/_figures/web-server-install-4.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-4.png rename to source/_figures/web-server-install-4.png diff --git a/source/tutorials/wordpress/figures/web-server-install-5.png b/source/_figures/web-server-install-5.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-5.png rename to source/_figures/web-server-install-5.png diff --git a/source/tutorials/wordpress/figures/web-server-install-6.png b/source/_figures/web-server-install-6.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-6.png rename to source/_figures/web-server-install-6.png diff --git a/source/tutorials/wordpress/figures/web-server-install-7.png b/source/_figures/web-server-install-7.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-7.png rename to source/_figures/web-server-install-7.png diff --git a/source/tutorials/wordpress/figures/web-server-install-8.png b/source/_figures/web-server-install-8.png similarity index 100% rename from source/tutorials/wordpress/figures/web-server-install-8.png rename to source/_figures/web-server-install-8.png diff --git a/source/tutorials/wordpress/figures/wp-install-1.png b/source/_figures/wp-install-1.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-1.png rename to source/_figures/wp-install-1.png diff --git a/source/tutorials/wordpress/figures/wp-install-2.png b/source/_figures/wp-install-2.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-2.png rename to source/_figures/wp-install-2.png diff --git a/source/tutorials/wordpress/figures/wp-install-3.png b/source/_figures/wp-install-3.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-3.png rename to source/_figures/wp-install-3.png diff --git a/source/tutorials/wordpress/figures/wp-install-4.png b/source/_figures/wp-install-4.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-4.png rename to source/_figures/wp-install-4.png diff --git a/source/tutorials/wordpress/figures/wp-install-5.png b/source/_figures/wp-install-5.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-5.png rename to source/_figures/wp-install-5.png diff --git a/source/tutorials/wordpress/figures/wp-install-6.png b/source/_figures/wp-install-6.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-6.png rename to source/_figures/wp-install-6.png diff --git a/source/tutorials/wordpress/figures/wp-install-7.png b/source/_figures/wp-install-7.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-7.png rename to source/_figures/wp-install-7.png diff --git a/source/tutorials/wordpress/figures/wp-install-8.png b/source/_figures/wp-install-8.png similarity index 100% rename from source/tutorials/wordpress/figures/wp-install-8.png rename to source/_figures/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/conf.py b/source/conf.py index 86fe2a1a..b5eaee24 100644 --- a/source/conf.py +++ b/source/conf.py @@ -167,7 +167,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/get-started/index.rst b/source/get-started/index.rst index b15908dd..6527f9d0 100644 --- a/source/get-started/index.rst +++ b/source/get-started/index.rst @@ -48,7 +48,7 @@ Install in a virtual machine virtual-machine-install/* ../../guides/maintenance/increase-virtual-disk-size.rst -Install in the cloud +Deploy to the cloud ******************** .. toctree:: 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 afdcd7d6..8d646c2c 100644 --- a/source/tutorials/docker/docker.rst +++ b/source/tutorials/docker.rst @@ -1,7 +1,7 @@ .. _docker: -Run Docker\* -############ +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 94% rename from source/tutorials/flatpak/flatpak.rst rename to source/tutorials/flatpak.rst index 6bf09b14..78867b35 100644 --- a/source/tutorials/flatpak/flatpak.rst +++ b/source/tutorials/flatpak.rst @@ -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/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/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 d1b7ae32..9b2853f0 100644 --- a/source/tutorials/fmv.rst +++ b/source/tutorials/fmv.rst @@ -1,7 +1,7 @@ .. _fmv: -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 c3708d8a..cd8a49af 100644 --- a/source/tutorials/index.rst +++ b/source/tutorials/index.rst @@ -9,19 +9,4 @@ Explore our tutorials to discover what you can do with |CL|! :maxdepth: 1 :glob: - wordpress/wordpress - flatpak/flatpak - machine-learning/machine-learning - docker/docker - hadoop - fmv - smb/smb* - spark - kata - kubernetes/kubernetes* - yubikey-u2f - nvidia - nvidia-cuda - redis - proxy - kata_migration \ No newline at end of file + * \ No newline at end of file diff --git a/source/tutorials/kubernetes/kubernetes-bp.rst b/source/tutorials/kubernetes-bp.rst similarity index 100% rename from source/tutorials/kubernetes/kubernetes-bp.rst rename to source/tutorials/kubernetes-bp.rst diff --git a/source/tutorials/kubernetes/kubernetes.rst b/source/tutorials/kubernetes.rst similarity index 100% rename from source/tutorials/kubernetes/kubernetes.rst rename to source/tutorials/kubernetes.rst diff --git a/source/tutorials/machine-learning/machine-learning.rst b/source/tutorials/machine-learning.rst similarity index 94% rename from source/tutorials/machine-learning/machine-learning.rst rename to source/tutorials/machine-learning.rst index 7e640526..710e5cc9 100644 --- a/source/tutorials/machine-learning/machine-learning.rst +++ b/source/tutorials/machine-learning.rst @@ -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/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/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/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/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/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/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/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/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/run-cell-button.png diff --git a/source/tutorials/proxy.rst b/source/tutorials/proxy.rst index f7d33270..d266f77d 100644 --- a/source/tutorials/proxy.rst +++ b/source/tutorials/proxy.rst @@ -1,7 +1,7 @@ .. _tutorial-proxy: -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/smb/smb-desktop.rst b/source/tutorials/smb-desktop.rst similarity index 93% rename from source/tutorials/smb/smb-desktop.rst rename to source/tutorials/smb-desktop.rst index ac185217..de0f8019 100644 --- a/source/tutorials/smb/smb-desktop.rst +++ b/source/tutorials/smb-desktop.rst @@ -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/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/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/smb-desktop-3.png :scale: 100% :alt: Authentication diff --git a/source/tutorials/smb/smb.rst b/source/tutorials/smb.rst similarity index 98% rename from source/tutorials/smb/smb.rst rename to source/tutorials/smb.rst index 4ffc7919..a76f526d 100644 --- a/source/tutorials/smb/smb.rst +++ b/source/tutorials/smb.rst @@ -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/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/smb-2.png :scale: 70% :alt: View a share drive in Windows Explorer diff --git a/source/tutorials/wordpress/wordpress.rst b/source/tutorials/wordpress.rst similarity index 90% rename from source/tutorials/wordpress/wordpress.rst rename to source/tutorials/wordpress.rst index 451cdaa4..da6c9c03 100644 --- a/source/tutorials/wordpress/wordpress.rst +++ b/source/tutorials/wordpress.rst @@ -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..7fb47574 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/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/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/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/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/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/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/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/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..76e67108 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/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/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/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/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/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/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/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/wp-install-8.png :alt: WordPress blog :width: 600 diff --git a/source/tutorials/yubikey-u2f.rst b/source/tutorials/yubikey-u2f.rst index 83ff4c60..db61e0a0 100644 --- a/source/tutorials/yubikey-u2f.rst +++ b/source/tutorials/yubikey-u2f.rst @@ -1,7 +1,7 @@ .. _yubikey-u2f: -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: