starlingx/docs
Code Issues Proposed changes

Conditionalize content for reuse DS

Browse Source 
Change-Id: I6c8493c39d5d7a62a61993ce1fd0818d1097fc3d
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone 2024-04-11 11:15:36 +00:00
parent 781c6c011e
commit 8f14c755c4
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/contributor/doc_contribute_guide.rst
View File

@ -396,19 +396,24 @@ the file name/label string like this: ``architectural-considerations--d9dd4c105
Using tabbed content Using tabbed content
-------------------- --------------------
.. begin-using-tabbed-content
Content on the master branch can take advantage of the ``sphinx-tabs`` Content on the master branch can take advantage of the ``sphinx-tabs``
extension to organize content into tabs. extension to organize content into tabs.
.. begin-using-tabbed-content
Tabs are useful for presenting alternate sets of content in a way that does not Tabs are useful for presenting alternate sets of content in a way that does not
require that the reader interact with sets that are not of interest. This is require that the reader interact with sets that are not of interest. This is
particularly useful in procedures where some steps vary across two or more particularly useful in procedures where some steps vary across two or more
variable factors. Rather than maintain two or more seperate procedures, tabs variable factors. Rather than maintain two or more seperate procedures, tabs
can be used to show one of the alternate sets of content. For example, the can be used to show one of the alternate sets of content. For example, the
installation procedures make heavy use of tabs to allow the reader to switch |prod| installation procedures make heavy use of tabs to allow the reader to
between virtual and bare-metal versions of the procedures. See switch between virtual and bare-metal versions of the procedures.
:ref:`aio_simplex_install_kubernetes_r7` for an example.
.. only:: starlingx
See :ref:`aio_simplex_install_kubernetes_r7` for an example.
**Basic tabs** **Basic tabs**