As an early bird for project doc translation we build translated docs
here with an extra script. This procedure is usual in the main doc
project, but there are different versions of the same script.
Later we to centralize such things.
Change-Id: I906be044021c93b9aeb644bcd3c550df123a3c83
The latest openstackdocs theme is now providing defaults for
project name, version. We shouldn't ship this in our code.
Change-Id: I7943b5bae40515d260be21edd82284e9638880b0
When running the doc building a new scenario was generated,
and appened to the scenario-table-gen.html page. We should instead
generate that page from scratch, and ensure it's always the
same content. This doesn't clean the scenario table gen, it simply
makes sure the generated content is always ordered the same way.
Change-Id: I9098f5d76b73be5ef28684027ff5039cd52d6ddb
The documentation has currently multiple problems:
- The top left tag of the openstacktheme isn't consistent with
the latest available tag, which confuses people (see
related bug)
- There are unused variables that could deserve cleanup
- There are static content that can be discovered from files
- We don't leverage the dynamic nature of the configuration for
conditional upgrade messages, while we should.
Change-Id: If8776ee54fda5cdcc27be36e2031150914aa32b2
Related-Bug: #1755241
When using the external links, we are sometimes referring with
the full link, sometimes with the macro. This standardizes to
use the proper macro links.
Change-Id: I9ce0df5d7d6348c5e0b01877ec259d36f9988067
Bumping shas to head of stable/queens. For projects that don't
have that branch yet, a reminder was written on the same line as
the SHA.
Updates documentation to the appropriate branching.
On top of that:
- Placement API now only accepts GET, not HEAD
- Placement API now returns HTTP 200
- Designate returns the API versions under /, not under
/versions [1]
- Cloudwatch was disabled upstream [2], so all references are
removed.
[1]: https://developer.openstack.org/api-ref/dns/
[2]: https://bugs.launchpad.net/heat/+bug/1743707
Change-Id: I29e63008bf5c3cd8ed2deb8dcd13bc6a988891f5
Problems resolved:
- Errors relating to 'etc' folders which did not exist in the
target repositories have been eliminated.
- Some repositories were not being excluded from evaluation
for file/template updates. All appropriate exclusions are
now implemented.
- If an OSA role repository did not have the required folder
to copy rootwrap files into, the copy would fail and the
rootwrap files therefore be left out of the patch.
- When executed on Mac OS X, python2 is not found.
- Documentation is added to describe how to use the script
to handle periodic SHA bumps.
Change-Id: I628cd2c3156d118c17ca2f90d4ccf0bc5a080bbf
Move the playbooks/inventory folder, group_vars, and host_vars to
inventory/ in the root of the OpenStack-Ansible repo. This helps better
organize the repo structure since playbooks/ will now only contain
playbooks, shared task files, and included repo package var files.
group_vars and host_vars are moved alongside the inventory since that's
the default place that Ansible expects those folders and to help better
prepare for Ansible 2.4 where multiple inventories can be loaded,
automatically including relative group and host var files.
Effected docs, scripts, and variables have been updated with the new
paths.
Change-Id: If50e2412c3fd6575d7041deb8ecc9480b04184cc
This change adds in a dynamic table to our documentation so that we're
able to generate a table of all available scenarios and mark where
services are tested within. To make the dynamic scenario generation
easier the AIO scenario conf setup has been moved into it's own variable
file.
The file doc/source/contributor/scenario-table-gen.html has been touched
allowing sphinx to import and generate the required table as needed.
Change-Id: Ief5d180491d3a330890d6bfa06d43f565dd26103
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
current_release_branch_name is already defined a few line above, it's
not needed there.
Change-Id: Ib92602b24bd6abd8d428d455c427352de5521aac
Closes-Bug: #1717500
In order to ensure that the deploy guide and
other doc references point to the right places
we update the URL's accordingly.
Change-Id: I8360c47d108ac673ed744c659ba9d34a3ef4c33e
Closes-Bug: #1711108
In the upgrade tooling and the docs references we use
the series name in a few places. This updates them all
for development in the Queens cycle.
In the docs there are many references to Ocata manuals
which are left alone as the upstream Pike docs have not
been published yet.
Change-Id: Ice2169bd40f5712dd9ec9a9eb946fe0244f32294
Boss drum, motivating rhythm of life with the
healing, rhythmic synergy.
More seriously, this patch re-arranges the
documentation structure to conform to the
structure outlined in [1].
With it, some changes are made to effectively
transition the links and simplify the sphinx
configuration.
The Mitaka/Liberty documentation links are
removed as they are no longer available.
[1] http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Change-Id: Icc985de3af4de5ea7a5aa01b6e6f6e524c67f11b
git checkout master is release Pike.
Therefore git branch name != release branch name and
git branch name != stable/git branch name.
Therefore we introduce another config item for generating this.
Change-Id: Ied955d318f3dbf9d4d30a8ac56f61abb1734a63d
Since the deploy guide moved to a separate directory structure, relative
links throughout the docs have been pointing to nothing. This change
applies some logic to figure out the correct format for URLs based on
the current branch and the deploy guide/dev docs conventions.
The actual link generation is done via the sphinx.ext.extlinks
extension, which allows for defining custom link generation roles. This
achieves the desired behavior in terms of dynamic link construction, but
does alter the standard linking conventions.
Another side effect is that docs generate this way will always point
to the live URLs, not to HTML generated for a gate job. It may be
worthwhile using relative links within the deploy guide/developer docs
and only using these automatic external ones for cross-references.
Usage for dev docs looks like this:
:dev_docs:`Link title text <last-part-of-url.html>`
And for the deploy guide:
:deploy_guide:`Link title text <last-part-of-url.html>`
Some examples inline have been provided, to demonstrate how these fit in
different contexts.
Some small code style fixes are also included.
Change-Id: I4d065f1f2d7c1372f3f829ab9e5297d5028f2ee6
This patch adjust the branch names for Ocata to ensure that
the install guide and upgrade guide references are correct.
Also, the word TAG is replaced with the substitution reference
to ensure that the latest tag is always shown once the docs
move into a stable branch.
Finally, the developer note regarding the supported platform
for an AIO has been updated to reflect the Newton platform
support.
Change-Id: I1a8464917343c9533fe5698ab8da18bf1e1529d7
The default watermark color is distracting and makes the content
difficult to read. Tone it down to a light gray.
Change-Id: I2ca547dca93f89edb1416ac44169749028037621
Added a water mark to install-guide, developer-docs, upgrade-guide
and releasenotes to make clear to deployers which release they're
working with.
Modified conf.py that adds watermark to the documentation according
to particular branch. If the current branch is master than
watermark is 'Pre-release' and if the current branch is
stable/<release-name> than watermark is <release-name>.
As global-requirements does not have sphinxmark included in
stable/newton [1], the requirements is added in tox.ini.
I will replicate this patch to all the role documentation once its
gets merged to master.
[1] https://review.openstack.org/376429
Closes-Bug:1624489
Change-Id: If454938abb4990764076436cd428673b456eab3c
This patch does the following:
- Simplifies the sphinx configuration introduced in
https://review.openstack.org/371722 to reduce the
number of variables involved. The variables are
also ordered in the same way everywhere to make it
easier to read and troubleshoot.
- Simplifies some of the CLI guides to be more explicit
about the tag to checkout when cloning the git repo.
- Cleaned up some references which went to non-existant
documents.
- Added a link to the networking appendix.
- As per https://review.openstack.org/369650 the
backup directory for the upgrade process is now
the name of the source version the upgrade process is
working with.
Change-Id: Iee30a32f99a66d9facb049311cadf1b9a8b2170e
Modified conf.py that replaces certain variables with the strings
as per the release name. Thus it makes easier to update the document
whenever release changes.
Closes-Bug: 1620275
Change-Id: I3b9457fc9e193e6a4b417d935b8588b4d0a7e450
The docstrings for public functions within dynamic_inventory.py are
passed through Sphinx and added to the inventory documentation page.
This change also corrects some of the syntax for the docstrings to fix
warnings and errors.
Change-Id: Ic461b5cff1351111ce3221093f1d6627d2b10aab
This patch implements:
- The OpenStack Manuals documentation theme.
- Some minor content changes to the index pages to ensure
that they render correctly.
- Adjustments to the tox/requirements configuration in order
to implement doc8 checks to facilitate improved documentation
checking for incoming patches.
- Adjustments to the sphinx configuration for easier
maintenance.
Note:
The bug_title in the openstackdocstheme is not currently
customisable. A patch to implement the ability to do so
has been submitted: https://review.openstack.org/338299
Partially-Implements: blueprint osa-install-guide-overhaul
Change-Id: I8af1a7ce9008e70abad00be96614c9997f59596b
This updates the use of OpenStack-Ansible in various docs to ensure that they
are all correctly capitalised.
This also removes 'indices and tables' from the Dev Docs as none of the links
work.
Change-Id: I30a16a2d6d6ac355c794de563afd4b3f661a9b32
This adds a fix to ensure that the published docs have the correct
link to the browsable source code as implemented in
https://review.openstack.org/236091
It also includes an exclusion of the doc directory from the pep8
check as the documentation conf.py requires the lengthy line.
It also updates the dev-requirements for the docs jobs to ensure
that the requirements are in line with upstream.
Change-Id: I52b5ede12667cf454d99a053e20eba4461b8ee75
This change updates all fo the names that we were using to the post
openstack migration name for openstack-ansible.
Change-Id: I6524af53ed02e19a0f56908e42a65d2dae8b71e3
Convert RPC installation guide from DocBook to RST,
remove content specific to Rackspace, and create initial
OSAD installation guide.
Change-Id: I3eedadc8ba441b4d931720dd6e3f7f3489302a9c
Co-Authored-By: Matt Kassawara <mkassawara@gmail.com>
This commit gets the doc directory and Sphinx configuration started.
Further documentation will depend on the Sphinx files and the index.rst
file at the very least.
The dev-requirements were updated to install Sphinx, and a gating script
was added to do the building for when we move to actually do gating on
the docs. The docs gate script is currently set to treat warning as
errors.
Change-Id: I977a2e53f1b0981cbc702ac53f2198d9f6a9da9d
Implements: blueprint developer-docs
