Fix broken links in README and update packages
Change-Id: Ic4a7b769d883e2a2d61c5273522caa9c5c5c6a20
This commit is contained in:
parent
9ba2ebd092
commit
d8b4b6d043
@ -6,7 +6,7 @@ This repository contains the source files for the OpenStack High Availability
|
||||
Guide.
|
||||
|
||||
You can read this guide at `docs.openstack.org/ha-guide
|
||||
https://docs.openstack.org/ha-guide/>`_.
|
||||
<https://docs.openstack.org/ha-guide/>`_.
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
@ -22,7 +22,7 @@ with it preinstalled, but you can review the `installation instructions
|
||||
do not have it by default.
|
||||
|
||||
Once git is installed, you can follow the instructions for your platform to
|
||||
`install git-review <https://www.mediawiki.org/wiki/Gerrit/git-review>`_.
|
||||
`install git-review <https://docs.opendev.org/opendev/git-review/latest/installation.html>`_.
|
||||
|
||||
The last step is to configure git with your name and email address used for
|
||||
your Gerrit account set up so it can link you patch to your user. Run the
|
||||
@ -36,6 +36,7 @@ following to set these values:
|
||||
|
||||
Submitting Updates
|
||||
------------------
|
||||
|
||||
Proposing updates to the documentation is fairly straight forward once you've
|
||||
done it, but there are a few steps that can appear intimidating your first
|
||||
couple times through. Here is a suggested workflow to help you along the way.
|
||||
@ -63,13 +64,14 @@ to the docs.openstack.org site.
|
||||
|
||||
Local Testing
|
||||
-------------
|
||||
|
||||
If you would like to build the docs locally to make sure there are no issues
|
||||
with the changes, and to view locally generated HTML files, you will need to do
|
||||
a couple extra steps.
|
||||
|
||||
The jobs are run using a tool called `tox`. You will need to install tox on
|
||||
your platform first following its `installation guide
|
||||
<https://tox.readthedocs.io/en/latest/install.html>`_.
|
||||
<https://tox.wiki/en/latest/installation.html>`_.
|
||||
|
||||
You can then run the following to perform a local build with some tests:
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# The order of packages is significant, because pip processes them in the order
|
||||
# of appearance. Changing the order has an impact on the overall integration
|
||||
# process, which may cause wedges in the gate later.
|
||||
openstackdocstheme>=2.1.1 # Apache-2.0
|
||||
doc8>=0.6.0 # Apache-2.0
|
||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||
openstackdocstheme>=3.5.0 # Apache-2.0
|
||||
sphinx>=8.1.3 # BSD
|
||||
doc8>=1.1.2 # Apache-2.0
|
||||
|
Loading…
x
Reference in New Issue
Block a user