Commit Graph

20 Commits

Author SHA1 Message Date
Andreas Jaeger f81cf9a905 Update docs building
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
2019-08-11 12:06:13 +02:00
Adrian Turjak bfef179935 Add link to Read the Docs for project doc
Change-Id: I748b5036d40a32441f8953741fa68f61cd1f2aad
2017-11-04 18:59:45 +13:00
Amelia Cordwell 6cbf3fa7f7 Documentation and Api Reference
* 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
2017-11-04 18:00:28 +13:00
Amelia Cordwell ae5c1943c9 Add Version Endpoints
* 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
2017-09-15 14:30:31 +12:00
Amelia Cordwell 6f60b059f4 Added UpdateProjectQuota
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
2017-09-13 17:09:02 +12:00
adrian-turjak 3a35e66a66 Updating the docs to match current state
* 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
2017-05-29 12:57:42 +12:00
adrian-turjak af986c28fc Renaming StackTask to Adjutant
* This patch is just a search and replace with minor tweaks.
* No functional changes, just renaming.

Change-Id: I103790be7c0cd9234545e25e21ab1768cb5eb131
2017-05-17 12:25:45 +12:00
Amelia Cordwell 829d6ac30e Added Update Email task and action
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
2017-05-16 18:17:25 +12:00
Amelia Cordwell 13cb4716cd Pagination for Task List
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
2017-05-08 13:24:16 +12:00
adrian-turjak 2686e009b5 updating readme to reflect new tox test args
Change-Id: I11da26782a83783eb9e0c28bf119058514a8fa26
2016-12-07 10:09:30 +13:00
Dale Smith bb033f4f89 Refactor action names and structure
* 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
2016-10-04 16:41:14 +01:00
adriant 4b7946be22 adding devstack deployment guide
Change-Id: Iaf6e4afa96f79551931ec8c4a6ec4e7c5f47113e
2016-04-29 13:29:28 +12:00
adriant 103fe2f4dd Add note about custom templates to README
Change-Id: I16d2c739a76d6db40301424de639614e231be7a8
2016-04-18 16:52:58 +12:00
Dale Smith 020dd616ea Incrementing package version to 0.1.4
Change-Id: I93e4dc3c981356842e724ca8dadf2fb9251b0ce0
2016-03-22 15:23:03 +00:00
adriant a20978ac96 Some cleanup of documentation and licenses
* 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
2016-02-19 14:51:09 +13:00
Dale Smith 6c8a4da2df Adding debian packaging with dh-virtualenv.
* Only installs code+virtualenv, not uwsgi etc
 * Build with: dpkg-buildpackage -us -uc

Change-Id: I18be6107592c065085c6a2cf49cf9bc061a8313f
2016-02-10 16:14:22 +13:00
adriant fa0aeed2af Updating the readme file a bit
Change-Id: I32b95cd752c4810ce0092c6abbf0b5f6ca835a30
2015-12-16 01:02:38 +13:00
adriant af54cdf650 Renaming Registration model to Task
Change-Id: I83801c7bf40360d36d4e6ddcd17238cf39792c58
2015-09-18 18:26:45 +01:00
Dale Smith 9384abc87d Updated readme to include dev instructions.
Change-Id: I2c2d518c7dd7edade6f4223eb477a1f25c493a4a
2015-09-17 19:28:52 +01:00
adriant 7895958e29 Adding readme
Change-Id: Ied08582fc8bcb348707f9e042eb6bff69d36c7d7
2015-03-26 12:01:42 +13:00