Update TM&B in tutorials section of docs (#1193)

* Update TM&B in tutorials section of docs

- Add disclaimers for Intel trademarks
- Update some 3rd party trademark attributions

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

* Correct broken link in kubernetes.rst

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

* - minor edit: escape asterisk(*) per feedback.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale
2020-06-26 12:51:20 -07:00
committed by GitHub
parent d6aa1285ce
commit 52b294d2af
12 changed files with 46 additions and 38 deletions
+2 -2
View File
@@ -1,7 +1,7 @@
.. _spark:
Apache\* Spark\*
################
Apache\* Spark
##############
This tutorial describes how to install, configure, and run Apache Spark on
|CL-ATTR| on a single machine running the master daemon and a worker daemon.
+3 -2
View File
@@ -4,7 +4,7 @@ Broadcom\* Drivers
##################
Broadcom manufactures wireless network interfaces, including devices that
support WiFi and Bluetooth.
support WiFi and Bluetooth® technology.
Broadcom wireless devices on Linux\* have a lot of different combinations of
possible required software depending on the exact model of your device. These
@@ -96,7 +96,7 @@ and has to be built as an out-of-tree kernel module.
It is recommended to use the :ref:`LTS kernel <compatible-kernels>` if you
have to use this driver.
#. See if your device is supported and download the **Linux® STA 64-bit
#. See if your device is supported and download the **Linux\* STA 64-bit
driver** from
`Broadcom's download website
<https://www.broadcom.com/support/download-search?pg=&pf=Wireless+LAN+Infrastructure>`_
@@ -236,3 +236,4 @@ Troubleshooting
different path than expected. Check the output of :command:`sudo dmesg |
grep -i firmware` for firmware loading issues.
*The Bluetooth® word mark and logos are registered trademarks owned by Bluetooth SIG, Inc. and any use of such marks by Intel Corporation is under license.*
+2 -2
View File
@@ -143,8 +143,8 @@ typically located at :file:`/etc/docker/daemon.json`. |CL| features a
sudo systemctl restart docker
Pulling and running an image from Docker Hub
********************************************
Pulling and running an image from Docker Hub\*
**********************************************
`Docker Hub`_ is a publicly available container image repository which
comes pre-configured with Docker. In the example below we will pull and run
+11 -11
View File
@@ -3,7 +3,7 @@
Flatpak\*
#########
This tutorial shows how to install a `Flatpak`_ app on |CL| using Gnome\* Software
This tutorial shows how to install a `Flatpak`_ app on |CL| using GNOME\* Software
and the command line.
.. contents::
@@ -37,21 +37,21 @@ Prerequisites
sudo swupd bundle-add desktop-autostart
Install a Flatpak app with Gnome Software
Install a Flatpak app with GNOME Software
*****************************************
|CL| desktop comes with Gnome Software installed. Flatpak apps can be
installed from within Gnome Software.
|CL| desktop comes with GNOME Software installed. Flatpak apps can be
installed from within GNOME Software.
#. Launch Gnome Software from your desktop.
#. Launch GNOME Software from your desktop.
#. Search for the Flatpak app that you want to install, as shown in Figure 1.
.. figure:: /_figures/flatpak/flatpak-01.png
:scale: 50%
:alt: Searching for Filezilla app in Gnome Software
:alt: Searching for Filezilla app in GNOME Software
Figure 1: Searching for Filezilla app in Gnome Software
Figure 1: Searching for Filezilla\* app in GNOME Software
#. When you find the app you want to install, click it to view application
details.
@@ -61,12 +61,12 @@ installed from within Gnome Software.
.. figure:: /_figures/flatpak/flatpak-02.png
:scale: 50%
:alt: Filezilla Flatpak detail page in Gnome Software
:alt: Filezilla Flatpak detail page in GNOME Software
Figure 2: Filezilla Flatpak detail page in Gnome Software
Figure 2: Filezilla Flatpak detail page in GNOME Software
#. After installation is complete, the new application will be in your
Gnome applications list, as shown in Figure 3.
GNOME applications list, as shown in Figure 3.
.. figure:: /_figures/flatpak/flatpak-03.png
:scale: 50%
@@ -81,7 +81,7 @@ Install a Flatpak with the command line
Both Flathub and the Clear Linux Store provide the command line instructions
for installing a Flatpak. Figure 4 shows the command line instructions to
install Filezilla from the Clear Linux Store:
install Filezilla\* from the Clear Linux Store:
.. figure:: /_figures/flatpak/flatpak-04.png
:scale: 50%
+3 -1
View File
@@ -277,8 +277,10 @@ application code.
You have successfully installed an FMV development environment on |CL|.
Furthermore, you used cutting edge compiler technology to improve the
performance of your application based on Intel® architecture technology and
performance of your application based on Intel® architecture and
profiling of the specific execution of your application.
*Intel and the Intel logo are trademarks of Intel Corporation or its subsidiaries.*
.. _GCC: https://gcc.gnu.org
.. _make-fmv-patch: https://github.com/clearlinux/make-fmv-patch
+6 -6
View File
@@ -35,7 +35,7 @@ For more background information see:
* `What is Docker?`_
* `What is Kata Containers?`_
* `What is Kata Containers\*?`_
Prerequisites
*************
@@ -463,8 +463,8 @@ Kubernetes container runtime:
Add the Kata runtime to Kubernetes
-----------------------------------
For information on Kata as a container runtime, see `What is Kata
Containers?`_. Using Kata Containers is optional.
For information on Kata as a container runtime, see `What is Kata Containers\*?`_.
Using Kata Containers is optional.
You can use *kata-deploy* to install all the necessary parts of Kata
Containers after you have a Kubernetes cluster running with one of the CRI's
@@ -733,15 +733,15 @@ limitation of using Dockershim is that all pods on the Kubernetes node will
inherit and use the default runtime that Docker is set to use. To be able to
specify a container runtime per-Kerbernetes service, use CRI+O or containerd.
What is Kata Containers?
========================
What is Kata Containers\*?
==========================
`Kata Containers`_ is an alternative OCI compatible runtime that secures
container workloads in a lightweight virtual machine. It provides stronger
workloads isolation using hardware virtualization technology as a second layer
of defense for untrusted workloads or multi-tenant scenarios.
The Kata Containers\* (kata-runtime) adheres to :abbr:`OCI (Open Container
The Kata Containers (kata-runtime) adheres to :abbr:`OCI (Open Container
Initiative*)` guidelines and works seamlessly with Kubernetes through Docker,
containerd, or CRI+O.
+1 -1
View File
@@ -4,7 +4,7 @@ LAMP Web Server
###############
This tutorial provides instructions on how to set up a
:abbr:`LAMP (Linux, Apache\*, MySQL, PHP)` web server on |CL-ATTR| and how
:abbr:`LAMP (Linux\*, Apache\*, MySQL\*, PHP)` web server on |CL-ATTR| and how
to use phpMyAdmin\* to manage an associated database. Note that this
tutorial installs MariaDB\*, which is a drop-in replacement for MySQL\*.
+10 -8
View File
@@ -41,21 +41,21 @@ Known issues
Systems with multiple graphics devices, including integrated graphics (iGPU),
are known to be problematic.
.. note:: NVIDIA Optimus
.. note:: NVIDIA Optimus\*
Some systems come with a hybrid graphics configuration for a balanced power
and performance profile. This configuration is commonly found on
laptops. `NVIDIA Optimus* technology
laptops. `NVIDIA Optimus technology
<https://www.geforce.com/hardware/technology/optimus>`_, is designed to
allow switching seamlessly between a NVIDIA device and another graphics
devices sharing the same display.
Getting NVIDIA Optimus* on Linux working well with both graphics devices
Getting NVIDIA Optimus on Linux working well with both graphics devices
adds an additional level of complexity with platform specific steps and may
require additional software. Installation for systems with NVIDIA Optimus*
require additional software. Installation for systems with NVIDIA Optimus
with both graphics devices operating is not covered by the scope of this
documentation. As a simple workaround, some systems can disable one of the
graphics devices or NVIDIA Optimus* in the system firmware.
graphics devices or NVIDIA Optimus in the system firmware.
.. note::
The :ref:`Long Term Support (LTS) kernel <compatible-kernels>` variant is
@@ -76,7 +76,7 @@ and sustainable on |CL|.
#. Remove the kernel command-line parameter *intel_iommu=igfx_off* or disable
input–output memory management unit (IOMMU), also known as Intel®
Virtualization Technology for Directed I/O (VT-d), in your system EFI/BIOS.
Virtualization Technology (Intel® VT) for Directed I/O (Intel® VT-d), in your system EFI/BIOS.
See `this GitHub report
<https://github.com/clearlinux/distribution/issues/1274>`_ and the NVIDIA
documentation on `DMA issues
@@ -428,8 +428,8 @@ installing the NVIDIA drivers until an Xorg configuration has been defined for
your monitors.
"Oh no! Something has gone wrong" GNOME crash
=============================================
"Oh no! Something has gone wrong" GNOME\* crash
===============================================
.. figure:: /_figures/nvidia/nvidia-gnome-crash.png
@@ -522,6 +522,8 @@ Additional resources
* `NVIDIA Accelerated Linux Graphics Driver Installation Guides <https://download.nvidia.com/XFree86/Linux-x86_64/>`_
*Intel and the Intel logo are trademarks of Intel Corporation or its subsidiaries.*
.. _`nouveau project`: https://nouveau.freedesktop.org/wiki/
.. _`NVIDIA Driver Downloads website`: https://www.nvidia.com/download/index.aspx
+3 -2
View File
@@ -196,7 +196,7 @@ In this example, we'll imagine a FaaS solution where: a user provides a URL to
a pictures, which invokes a function to do image classification and outputs
the result.
We will use the `OpenVINO Deep Learning Deployment Toolkit (DLDT)
We will use the `OpenVINO™ toolkit - Deep Learning Deployment Toolkit (DLDT)
<https://software.intel.com/en-us/openvino-toolkit/>`_ to do the image
inference. As inference development is not the focus of this example, we will
just use the built-in sample "`classification_sample_async
@@ -208,7 +208,7 @@ We'll use the *python3-clearlinux* template as a base and customize it by:
* Adding additional |CL| bundles (*bundles.txt*)
* Adding additional required python packages (*requirements.txt*)
* Adding a script to download and convert dldt models (*helper_script.sh*)
* Adding a script to download and convert DLDT models (*helper_script.sh*)
* Finally, we'll develop the python function to be run (*handler.py*)
More ways to customize the |CL| based OpenFaaS templates can be found in the
@@ -385,3 +385,4 @@ More ways to customize the |CL| based OpenFaaS templates can be found in the
Figure 3: OpenFaaS web interface invoke function
*Intel, OpenVINO, and the Intel logo are trademarks of Intel Corporation or its subsidiaries.*
+1 -1
View File
@@ -62,7 +62,7 @@ Prerequisites
PHP does not require a web server for operation. If you need a web
server, refer to :ref:`lamp-server-install` for instructions on setting
up a :abbr:`LAMP (Linux, Apache\*, MySQL, PHP)` server, or use
up a :abbr:`LAMP (Linux, Apache\*, MySQL\*, PHP)` server, or use
:command:`swupd` to install :file:`nginx` or similar.
+1 -1
View File
@@ -5,7 +5,7 @@ Redis\*
In this tutorial, you'll install :abbr:`Redis (REmote DIctionary Server)`
and launch a `Redis-server` on |CL-ATTR|. We invite you to pull our
`Clear Linux Redis instance`_ on dockerhub\* for application or
`Clear Linux Redis instance`_ on Docker Hub\* for application or
infrastructure development.
.. contents::
+3 -1
View File
@@ -4,7 +4,7 @@ WordPress\* Server
##################
This tutorial shows you how to install the WordPress\* components on your |CL|
:abbr:`LAMP (Linux, Apache, MySQL, PHP)` server. At the end of
:abbr:`LAMP (Linux, Apache\*, MySQL\*, PHP)` server. At the end of
:ref:`lamp-server-install`, you created a WordPress-ready database using
phpMyAdmin\* and MariaDB\*. Now that the LAMP server is up and running, you
can add the WordPress components needed to host a WordPress website on your system.
@@ -205,6 +205,8 @@ You have successfully installed WordPress on a host system.
Add new entries to your blog and share them with the world using |CL|!
*Intel and the Intel logo are trademarks of Intel Corporation or its subsidiaries.*
.. _`step-by-step guide`:
https://codex.wordpress.org/Installing_WordPress#Famous_5-Minute_Install