Browse Source

Update landing pages for docs, api-ref, and release notes:

- Use updated project name in titles/text
- Correct text for link to Storyboard (docs)
- Correct capitalization in section headings
- Correct formatting for section headings
- Update project name in link to release notes, api-ref
- Update project name in config for docs/releasenotes/api-ref

patch 5: Update to use 'Metal' instead of 'Bare Metal' per comments

Story:2007193
Task:38340

Change-Id: I22aa2f15850d4b5ecf01fd78c015b772b87a4932
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
changes/62/702762/5
Kristal Dale 2 years ago
parent
commit
d75d427c11
  1. 2
      api-ref/source/conf.py
  2. 13
      api-ref/source/index.rst
  3. 2
      doc/source/conf.py
  4. 24
      doc/source/index.rst
  5. 2
      releasenotes/source/conf.py
  6. 6
      releasenotes/source/index.rst

2
api-ref/source/conf.py

@ -42,7 +42,7 @@ master_doc = 'index'
# General information about the project.
repository_name = 'openstack/stx-metal'
project = u'stx-metal'
project = u'StarlingX Metal'
bug_project = 'starlingx'
bug_tag = 'stx.metal'

13
api-ref/source/index.rst

@ -1,12 +1,13 @@
=======================
stx-metal API Reference
=======================
===================
Metal API Reference
===================
Use the StarlingX stx-metal API to maintain and manage physical hosts.
Use the StarlingX Metal API to maintain and manage physical hosts.
stx-metal API content can be searched using the :ref:`search page <search>`.
Search Metal API content using the :ref:`search page <search>`.
API Reference
-------------
API reference
-------------
.. toctree::

2
doc/source/conf.py

@ -20,7 +20,7 @@
# -- Project information -----------------------------------------------------
project = u'stx-metal'
project = u'StarlingX Metal'
copyright = u'2018, StarlingX'
author = u'StarlingX'

24
doc/source/index.rst

@ -1,33 +1,35 @@
=======================
stx-metal Documentation
StarlingX Metal Project
=======================
The StarlingX stx-metal project provides physical host maintenance and
management.
The starlingX/metal project provides physical host maintenance and management.
Release Notes
-------------
Release notes
-------------
.. toctree::
:maxdepth: 1
Release Notes <https://docs.starlingx.io/releasenotes/stx-metal>
Release Notes <https://docs.starlingx.io/releasenotes/metal>
API Reference
-------------
API reference
-------------
.. toctree::
:maxdepth: 1
API Reference <https://docs.starlingx.io/api-ref/stx-metal>
API Reference <https://docs.starlingx.io/api-ref/metal>
-----
Links
-----
* Source: `stx-metal`_
* Code Review: `Gerrit`_
* Bugs: `Storyboard`_
* Source: `starlingx/metal`_
* Code review: `Gerrit`_
* Project tracking: `Storyboard`_
.. _stx-metal: https://opendev.org/starlingx/metal
.. _starlingx/metal: https://opendev.org/starlingx/metal
.. _Gerrit: https://review.opendev.org/#/q/project:starlingx/metal
.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/metal

2
releasenotes/source/conf.py

@ -47,7 +47,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = 'stx-metal'
project = u'StarlingX Metal'
# Release notes are version independent, no need to set version and release
release = ''

6
releasenotes/source/index.rst

@ -1,6 +1,6 @@
=======================
stx-metal Release Notes
=======================
=============================
StarlingX Metal Release Notes
=============================
.. toctree::
:maxdepth: 2

Loading…
Cancel
Save