From 97cc3cfbbdf0aa09d42b2b73dc98786814df621c Mon Sep 17 00:00:00 2001 From: Kevin Putnam Date: Mon, 6 Jan 2020 15:50:59 -0800 Subject: [PATCH] Update landing page (#975) * 1. Updated landing page to emulate look and feel of docs page on clearlinux.org 2. Added Trademarks, Cookies, and Privacy Terms links to footer with some css formatting 3. Added some CSS to pre-emptively remove added formatting to definition list entries in sphinx/rtd theme in version 2 and above Signed-off-by: Kevin Putnam * Added start/end for footer bullet list support Signed-off-by: Kevin Putnam * 1. Hid toctree to reduce duplication. 2. Changed IRC link to match what is currently on the clearlinux.org site. Signed-off-by: Kevin Putnam --- .../_themes/otc_tcs_sphinx_theme/layout.html | 4 + .../otc_tcs_sphinx_theme/static/tcs_theme.css | 19 +++ source/conf.py | 2 +- source/index.rst | 117 ++++++++++-------- 4 files changed, 91 insertions(+), 51 deletions(-) diff --git a/source/_themes/otc_tcs_sphinx_theme/layout.html b/source/_themes/otc_tcs_sphinx_theme/layout.html index 94f4617f..c9741d66 100644 --- a/source/_themes/otc_tcs_sphinx_theme/layout.html +++ b/source/_themes/otc_tcs_sphinx_theme/layout.html @@ -47,6 +47,10 @@

*Other names and brands may be claimed as the property of others.

+
{% endblock %} 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 8a68bcb7..1a3a650b 100644 --- a/source/_themes/otc_tcs_sphinx_theme/static/tcs_theme.css +++ b/source/_themes/otc_tcs_sphinx_theme/static/tcs_theme.css @@ -520,3 +520,22 @@ div.linenodiv:before { /*add extra new line to make sure code and line numbers a } /*End support for multi-column sections*/ + +/*Start fix for changes made to definition lists in sphinx/rtd post version 2.0*/ + +.rst-content dl:not(.docutils) dt { + border-top: none; + background: none; +} + +/*end fix to definition lists*/ + +/*start formatting support for horizontal bullet list without bullets in footer*/ +ul.footer__menu_list { + display: inline-flex; +} + +li.footer__menu_list { + margin-right: 30px; +} +/*end footer bullet list support*/ \ No newline at end of file diff --git a/source/conf.py b/source/conf.py index cccfdd64..5d8e37a3 100644 --- a/source/conf.py +++ b/source/conf.py @@ -54,7 +54,7 @@ master_doc = 'index' # General information about the project. #project = u'Clear Linux* project' project = u'Clear Linux* Project Docs' -copyright = u'2019.' +copyright = u'2020.' author = u'many' # The version info for the project you're documenting, acts as replacement for diff --git a/source/index.rst b/source/index.rst index 22b386d8..cc6cc720 100644 --- a/source/index.rst +++ b/source/index.rst @@ -1,61 +1,78 @@ .. _clear-linux: -|CL-PRJ| +|CL-PRJ| Documentation ############################################# -Welcome to the |CL-ATTR| documentation pages, the source for |CL| documentation. +.. container:: multicolumns -Our documentation is divided into the following sections: + .. container:: column verticalcard + + .. rst-class:: colh2 + + Highlights + + :ref:`autospec` + **autospec** is a tool to assist in the automated creation and + maintenance of RPM packaging in Clear Linux OS. + + :ref:`dlrs` + This tutorial shows you how to run benchmarking workloads in Clear + Linux OS using TensorFlow\* or PyTorch\* with the Deep Learning + Reference Stack. + + :ref:`docker` + Clear Linux OS supports multiple containerization platforms, + including a Docker solution. + + :ref:`developer-workstation` + Developer Workstation helps you find the Bundles you need to start + your Clear Linux OS development project. + + .. container:: column verticalcard + + .. rst-class:: colh2 + + Quicklinks + + :ref:`get-started` + Get up and running fast with Clear Linux\* OS. Use these step-by-step + instructions to guide you through the installation of Clear Linux OS + from bare metal to live image. + + :ref:`bare-metal-install-desktop` + These instructions guide you through the installation of Clear Linux + OS on bare metal using a bootable USB drive. + + :ref:`architect-lifecycle` + This guide provides DevOps with a model to architect the life-cycle + of a Clear Linux OS derivative that integrates custom software and + content using distinct workflows. + + :ref:`bundles` + Useful bundle commands for working with bundles on the Clear Linux OS. + + .. container:: column featurecard + + **Community** + + | `Ask the Clear Linux experts `_ + | `Clear Linux Forum `_ + | `Freenode IRC: #clearlinux `_ -:ref:`get-started` +.. container:: video - If you are new to |CL|, get started quickly with step-by-step instructions - for installing |CL| on bare metal, in a virtual environment, or as a live - image on a USB stick. + .. raw:: html -:ref:`about` + - |CL| is different from other Linux distributions. +.. toctree:: + :hidden: - Updates, ease of use, and custom derivatives are a few of the differences - this section explains. Orient yourself to these differences and why they - matter to you. - - .. raw:: html - - - -:ref:`guides` - - Guides cover a range of topics from |CL| features and tooling, to system - maintenance, network, and stacks. - -:ref:`Use case tutorials ` - - Sample use cases, with step-by-step instructions, show how to set up - third-party tools and software with |CL|. - -:ref:`reference` - - This section provides additional reference information on the |CL| project. - -:ref:`faq` - - The FAQ section provides answers to commonly asked questions about |CL|. - -:ref:`collaboration` - - This section describes how to contribute to |CL| documentation. - -.. toctree:: - :maxdepth: 2 - :hidden: - - get-started/index - about - guides/index - tutorials/index - reference/index - FAQ/index - collaboration/collaboration + get-started/index + about + guides/index + tutorials/index + reference/index + FAQ/index + collaboration/collaboration \ No newline at end of file