Follow PTI [1] for doc building:
* Create doc/requirements.txt file with all docs requirements.
* Switch to openstackdocstheme and update conf.py for this.
* Move doc8 to pep8 section since it's a linter.
Additionally:
* Fix all build errors with doc building.
* Update requirements list with license info.
* Use hacking instead of flake directly.
* Remove unused _static files, those are not needed.
* Update git URLs, fix contributor guide URL
* Move README.md to RST, everything else in this repo is RST
* Publish documents to docs.o.o - note that
https://adjutant.readthedocs.io/en/latest/ was last updated in March
2018
This adds jobs for building of release notes - only building since
there's no content yet - and publishing of documentation.
Publishing of api-ref can be done via:
https://review.opendev.org/675766
[1] https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation
Change-Id: I82f56ef5ea800899b2a8db795b6cf2b21d03ac7a
* API Reference and documentation as two seperate sphinx
document sets
* Information from the Devstack guide and README moved over
to the new documentation
* Configuration examples
* Examples of building plugins
* Both use the new sphinx-rtd-theme
Change-Id: If347905aa14b77b5943f1a9de97f6e287b98ce95
* At root URL will list all versions with respect to these [1]
guidelines.
* v1/ path will list it's own version information
[1] https://wiki.openstack.org/wiki/VersionDiscovery
Change-Id: I9162408ab0cea03ba1cbf3326d0af80188385501
Accessable at v1/openstack/quotas/.
A GET request returns json specifiing quota size, the current quota,
the current usage, and some details of any currently active quota
change tasks.
A POST request will update the quota for the project to a given
size. The data must contain a JSON dict with 'size' in it,
which will be the name of one of the pre-defined sizes.
Optionally regions (a list of region names) can be specified
which will restrict the update operation to those regions.
Change-Id: I907664f79f6eef0b5239139999cc7a28d246e446
* While the incode documentation has been updated quite
a bit, the readme has remained mostly untouched for too
long and needed some updates.
* Also added some notes about deprecation of older style
taskviews that ended up never being used in production
anyway.
Change-Id: I7f21b68e1e37fec0bcba75eeccc35213c4e0a5c0
* This patch is just a search and replace with minor tweaks.
* No functional changes, just renaming.
Change-Id: I103790be7c0cd9234545e25e21ab1768cb5eb131
The task only allows the current user to update their own email
address, a confirmation email is sent to the new address before
the switch.
Change-Id: I62b169d262c6455ffec96bdb29e254279e973851
Number of tasks per page can be specified in the get request,
but if not specified the endpoint will return all of them.
Change-Id: I524249bf7e9f16feba8c9beaeb66267ec7da874e
* Renamed Actions to include consistent suffix.
* Config change: 'handle_duplicates' is now renamed to 'duplicate_policy'
* Refactored duplicate code into shared functions.
* Adding a functional serializer test.
Change-Id: I79fa06f7098df7cc7fe2a228a606a0f4f54b5510
* mainly clean up to double check things
and help ensure anyone looking at this code
can get enough of an idea of things from the README
and code.
* also removing a catalyst specific line from the README
Change-Id: I648e668553970f2934d1608b8af89448990e3d3d