Also reorganizes the document structure to match both HTML and PDF docs.
Story: 2006100
Task: 35143
Change-Id: Ie3f38e2ecf52e6a6cbd52bb36196e6f589f1ca0f
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.
Note that redirects will be set up as well but let's point now to the
new location.
For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html
Change-Id: I53120e2ff3ae337a55c4cd0904bc9ad1dd54d082
The spec [1] recommends the following sections:
- install
- contributor
- configuration
- cli
- admin
- user
- reference
Only a few of these are useful here:
- contributor
- cli
- user
- reference
Add these and populate them.
[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration
Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
Since the description of the individual API calls have been moved to
the API Reference, the API Guide is more or less what the "overview"
in the original guide was. Therefore I just pointed to the guide, and
removed the phrase "-- the overview, at least --".
Change-Id: I8b1cb6a7ea4469a91f0dfe69d26f4ffec178ed43
Closes-Bug: 1678591
Signed-off-by: Simon Leinen <simon.leinen@gmail.com>
The instructions for deprecating commands predated reno
so this change updates them a bit to be current with our
processes now. Also adds a reminder to update the help
text/description of a command to mark it deprecated.
Change-Id: I530399ba9cf6c50bd0dbb06f231aee61466eebd6
The nova server liberty version is changing from 2015.2 to 12.0.0 and
the 2016.1 'M' release will be 13.0.0 so update the deprecation warnings
in the docs and code using those versions.
Depends on nova change 192406.
Change-Id: I6a35fa0dda798fad93b804d00a46af80f08d475c
* Remove releases (File removed in e334096aa3)
* Add link to man page
* Fix some docstring formatting
Change-Id: Iec67a6d32f0365e514394c1e3eb7d8e4ae6aff65
Since we haven't removed deprecated commands before, add some
documentation to the devref on the process for this type of change.
Change-Id: Iff6f5df372bec524757b84747c7a95bbf6412c35
Module novaclient.v1_1 is used as implementation of V1.1, V2 and V3.
Since future development(microversioning) will be done across V2,
implementation should be done in appropriate module(to prevent misleading).
Despite the fact that implementation for all versions are equal, discover
method for contrib path worked only for v1.1. This patch fixes this bug and
modifies shell tests to check all versions.
Change-Id: Ib6798f4dfe177586302141f522dc593560ce6a5b
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.
Change-Id: I75618aaf9e07324985a83ca74d35bcab59e186c1
Since ``tox`` is used as launcher in gates, it should be mentioned in docs
instead of ``python setup.py test``.
Change-Id: Ie5fcd9da755e1146b2b042fa5906aa28748980a6
OpenStack runs a git service now, so instead of linking to github URLs,
link to git.openstack.org.
Versions for pbr in setup.py actually wind up being an error (and a very
odd one) Remove them.
The setup hook in setup.cfg is no longer needed.
Change-Id: I8f48ac194e6c01e9bb06fa5df6f2b2bf28c01636
- Changes theme to default instead of nature.
- Explains in terms of Compute API instead of Rackspace
- Remove outdated reference to nova-manage command
- Remove unnecessary whitespace
Change-Id: I43d16cd053af0b4be48450fd638f9d17f9e5c4e7
Contributing blurb previously mentioned using Github pull requests.
Contributions should go to Gerrit instead.
Change-Id: Id7b7f968fa5a3785c19704b4c1c2408f48b335ca
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc/source and build results go in project/doc/build.
Change-Id: I868df12e3c15cc30043e782ce0a609b9574295cd
Stephen Finucane