From 1887b87f6f64ee5b66a881a851dd352831415723 Mon Sep 17 00:00:00 2001 From: Kevin Putnam Date: Thu, 6 Jun 2019 09:29:59 -0700 Subject: [PATCH] A bunch of improvements and proof of concept for moving tooling to top level. Signed-off-by: Kevin Putnam --- .../otc_tcs_sphinx_theme/static/tcs_theme.css | 4 ++ source/clear-linux/clear-linux.rst | 38 ++++++++---------- source/clear-linux/guides/guides.rst | 10 ----- .../{guides => }/tooling/autoproxy.rst | 0 .../{guides => }/tooling/autospec.rst | 0 .../tooling/figures/autoproxy_0.png | Bin .../{guides => }/tooling/ister.rst | 0 .../{guides => }/tooling/mixer.rst | 0 .../{guides => }/tooling/swupd-guide.rst | 0 source/clear-linux/tooling/tooling.rst | 13 ++++++ source/includes/get-started.txt | 2 + source/main-site-content/get-started.yml | 4 ++ 12 files changed, 39 insertions(+), 32 deletions(-) rename source/clear-linux/{guides => }/tooling/autoproxy.rst (100%) rename source/clear-linux/{guides => }/tooling/autospec.rst (100%) rename source/clear-linux/{guides => }/tooling/figures/autoproxy_0.png (100%) rename source/clear-linux/{guides => }/tooling/ister.rst (100%) rename source/clear-linux/{guides => }/tooling/mixer.rst (100%) rename source/clear-linux/{guides => }/tooling/swupd-guide.rst (100%) create mode 100644 source/clear-linux/tooling/tooling.rst create mode 100644 source/includes/get-started.txt create mode 100644 source/main-site-content/get-started.yml diff --git a/source/_themes/otc_tcs_sphinx_theme/static/tcs_theme.css b/source/_themes/otc_tcs_sphinx_theme/static/tcs_theme.css index 28546ac9..bedfcfd0 100644 --- a/source/_themes/otc_tcs_sphinx_theme/static/tcs_theme.css +++ b/source/_themes/otc_tcs_sphinx_theme/static/tcs_theme.css @@ -249,4 +249,8 @@ th,td { font-family: "IntelClear-Bold", Helvetica, Arial, sans-serif; margin-left: 0.67em; line-height: 100px; +} + +.wy-plain-list-disc li p:last-child, .rst-content .section ul li p:last-child, .rst-content .toctree-wrapper ul li p:last-child, article ul li p:last-child { + margin-bottom: 10px; } \ No newline at end of file diff --git a/source/clear-linux/clear-linux.rst b/source/clear-linux/clear-linux.rst index 8436cd1c..94fa4715 100644 --- a/source/clear-linux/clear-linux.rst +++ b/source/clear-linux/clear-linux.rst @@ -11,38 +11,32 @@ Welcome to the |CL-ATTR| documentation pages, the source for |CL| documentation. Our documentation is divided into the following sections: -* :ref:`get-started` +:ref:`get-started` + .. include:: /includes/get-started.txt - If you are new to |CL|, get started fast with tutorials for installing |CL| on - bare metal, in a virtual environment, or as a live image on a USB stick. +:ref:`concepts` + Wondering what makes |CL| different? Learn about |CL| features and what + differentiates |CL| from other Linux distros. -* :ref:`concepts` +:ref:`guides` + Guides show how to complete common tasks that help you leverage |CL| native + features effectively. From basic system configuration to advanced + management of a cloud installation, there is a guide for you. - Wondering what makes |CL| different? Learn about |CL| features and what - differentiates |CL| from other Linux distros. +:ref:`tutorials` + |CL| tutorials provide step-by-step instructions on how |CL| features can + be used and extended, frequently with third-party tools. -* :ref:`guides` - - Guides show how to complete common tasks that help you leverage |CL| native - features effectively. From basic system configuration to advanced management - of a cloud installation, there is a guide for you. - -* :ref:`tutorials` - - |CL| tutorials provide step-by-step instructions on how |CL| features can - be used and extended, frequently with third-party tools. - -* :ref:`reference` - - Find the detailed information you need to enable your configuration or task - in our |CL| reference section. +:ref:`reference` + Find the detailed information you need to enable your configuration or task + in our |CL| reference section. .. toctree:: :maxdepth: 2 :hidden: get-started/get-started - concepts/concepts + tooling/tooling guides/guides tutorials/tutorials reference/reference diff --git a/source/clear-linux/guides/guides.rst b/source/clear-linux/guides/guides.rst index d773743d..d6163063 100644 --- a/source/clear-linux/guides/guides.rst +++ b/source/clear-linux/guides/guides.rst @@ -6,16 +6,6 @@ Guides The following guides provide step-by-step instructions on using |CL|. Note: As of 22 May 2019 :file:`mixin` is no longer supported. -Tooling -======= - -.. toctree:: - :maxdepth: 1 - :glob: - - tooling/* - telemetrics/telem-guide - Maintenance =========== diff --git a/source/clear-linux/guides/tooling/autoproxy.rst b/source/clear-linux/tooling/autoproxy.rst similarity index 100% rename from source/clear-linux/guides/tooling/autoproxy.rst rename to source/clear-linux/tooling/autoproxy.rst diff --git a/source/clear-linux/guides/tooling/autospec.rst b/source/clear-linux/tooling/autospec.rst similarity index 100% rename from source/clear-linux/guides/tooling/autospec.rst rename to source/clear-linux/tooling/autospec.rst diff --git a/source/clear-linux/guides/tooling/figures/autoproxy_0.png b/source/clear-linux/tooling/figures/autoproxy_0.png similarity index 100% rename from source/clear-linux/guides/tooling/figures/autoproxy_0.png rename to source/clear-linux/tooling/figures/autoproxy_0.png diff --git a/source/clear-linux/guides/tooling/ister.rst b/source/clear-linux/tooling/ister.rst similarity index 100% rename from source/clear-linux/guides/tooling/ister.rst rename to source/clear-linux/tooling/ister.rst diff --git a/source/clear-linux/guides/tooling/mixer.rst b/source/clear-linux/tooling/mixer.rst similarity index 100% rename from source/clear-linux/guides/tooling/mixer.rst rename to source/clear-linux/tooling/mixer.rst diff --git a/source/clear-linux/guides/tooling/swupd-guide.rst b/source/clear-linux/tooling/swupd-guide.rst similarity index 100% rename from source/clear-linux/guides/tooling/swupd-guide.rst rename to source/clear-linux/tooling/swupd-guide.rst diff --git a/source/clear-linux/tooling/tooling.rst b/source/clear-linux/tooling/tooling.rst new file mode 100644 index 00000000..13e6bd96 --- /dev/null +++ b/source/clear-linux/tooling/tooling.rst @@ -0,0 +1,13 @@ +.. _clear-linux-tooling: + +Tooling +####### + +Clear Linux is a little different from other distros. Here are some important tools and concept for managing your install. + +.. toctree:: + :maxdepth: 1 + :glob: + + * + ../guides/telemetrics/telem-guide \ No newline at end of file diff --git a/source/includes/get-started.txt b/source/includes/get-started.txt new file mode 100644 index 00000000..d9c0fb92 --- /dev/null +++ b/source/includes/get-started.txt @@ -0,0 +1,2 @@ +If you are new to |CL|, get started fast with tutorials for installing |CL| on +bare metal, in a virtual environment, or as a live image on a USB stick. \ No newline at end of file diff --git a/source/main-site-content/get-started.yml b/source/main-site-content/get-started.yml new file mode 100644 index 00000000..cf0a59df --- /dev/null +++ b/source/main-site-content/get-started.yml @@ -0,0 +1,4 @@ +title: 'Getting Started' +type: 'documentation card' +content: /includes/get-started.txt +github_url: 'https://clearlinux.org/documentation/clear-linux/get-started' \ No newline at end of file