Commit Graph

3 Commits

Author SHA1 Message Date
Andreas Jaeger f10f95b455 Docs: Make robust with using real links
Our tools noticed that keystone links to
https://docs.openstack.org/keystone/latest/admin/identity-domain-specific-config.html
which does not exist anymore.

The page was removed but the link to it was not changed. Replace this
and similar links with internal links that will work even if files are
moved - and can be verified, thus sphinx will error in case of broken
targets.

These changes include a few other fixes for broken keystone links, e.g.
to renamed anchors.

For the include files in admin/configuration.rst and
admin/federation/configure_federation.rst: Rename them to *inc.
The files were
published twice (as separate files and on this page) and thus
referencing failed. Renaming avoids this.

Also, put doctree outside of html tree so that it does not get
published.

Change-Id: I3d07637b0046cc88a66bcb51a0a4fe7c146c1549
2019-08-09 20:15:14 +02:00
Colleen Murphy 74c1d5aa34 Reorganize admin guide
Now that most of the operator docs are consolidated into the admin
guide, it is huge and hard to find things. This patch breaks the guide
into groups to make it a little easier to navigate:

1. Getting started: basics of keystone and initializing a deployment.
2. Configuration: not a replacement for the main config docs but a
   grouping of all discussions on the various config options.
3. Operations: maintenance workflows like upgrading and cleanups
4. Tokens: an important part of keystone
5. RBAC: gets a section to itself
6. Advanced keystone features: grouping of lesser-known/lesser-used,
   not-required features.
7. Authentication mechanisms: various auth methods besides password,
   including the federation guide

Change-Id: I9039b7023d843349154d28ee0ee2c7b9a9eb97ab
2018-12-14 10:08:10 +01:00
Colleen Murphy ccb3d340e4 Rename admin guide pages
Some of the admin guide pages were prefixed with "identity-" because
they came from the centralized install guide or operators guide or
security guide or somewhere else. We don't need the prefix, everything
in keystone is identity. Remove the prefix from the affected pages so
that everything is consistent.

Change-Id: Icd172a39fe720472f1fb15395178f90282696ac9
2018-12-11 11:43:50 +01:00