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
The current external-dev.rst page only contains 3
links that are semi-hidden in the current docs layout
unless someone specifically clicks on the
"External Developer" link.
This change removes the external-dev page, which only
contained 3 links, and now those 3 links are available
on the contributor index. These links also now show
up on the main keystone documentation page as well for
easy access to readers.
Change-Id: Ib0106ade10f1760a91bbac8e3c8e43b1aeda0884
We have documentation on the various scopes keystone offers, but we
don't describe *how* other developers in OpenStack should use this
information.
This commit attempts to answer some of the most common authorization
scope questions we've heard and fixes up some wording to make the
document more clear.
Change-Id: Iaf53e632e1c4e7c2ef1fcbf0262d99d896c06157
This document is written for other developers working on OpenStack.
Its goal is to describe various concepts in a way that other
developers, who may not be familiar with keystone, can digest and use
effectively in their projects.
The introductory paragraph was phrased as if the v3 API just became a
thing, when it has actually been around for a long time. It also
eluded to underlying implementation details by mentioning paste
pipelines, which we no longer use.
This commit updates the introduction to be more relevant to the state
of things today.
Change-Id: I79564dc99fd65a5609bd548d12a0413ca3ee6b2a
We have a document that attempts to help describe keystone concepts
to other OpenStack developers. Now that we've added system scope to
keystone, it makes sense to refresh this document and make it more
helpful for services.
This should help services consume various scopes to protect APIs at
various levels (project, domain, system, et cetera).
Change-Id: I1a92ed0b6bbba44d1050a857c3609d918bb25b86
Closes-Bug: 1757151
The external developer document we have attempts to clarify various
concepts in keystone and make it easier for other developers writing
other services. Now that we've removed the v2.0 API, it makes sense
to update this documentation to refer to v2.0 in the past tense. Some
parts of the document seemed specific to operator documentation, which
has been either removed or reworked to the intended operators, other
service developers.
Change-Id: I809150f8b77a813e2300760fdcb1d11cfa8ca732
With the docs migration and re-arrangement, some docs
have been shifted to new places, however the referenced
links are still old. Some of them give 404 error or
just point to the home page. This patch fixes those URLs.
Change-Id: Ie6b18ab3d4aa346dac8436dd426277fee4f07fcd
The specification detailing the great documentation migration
requires a doc/source/contributor/ directory for all contributor
documentation. Keystone had a directory specifically for this type
of content but it was in doc/source/devref/.
This commit renames devref/ to contributor/ because the term
`contributor` is more inclusive of other community members that
aren't necessarily developers. The specification also requires this
convention for consistency with other projects.
Change-Id: Id6363213dc6ba6946bd272ca5ee67b4604afc5ac
Partial-Bug: 1694460
Abhishek Kekane