f81cf9a905
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
1.4 KiB
Team and repository tags
Adjutant
A basic workflow framework built using Django and Django-Rest-Framework to help automate basic Admin tasks within an OpenStack cluster.
Primarily built as user registration service that fits into the OpenStack ecosystem alongside Keystone, its purpose to fill functionality missing from Keystone. Ultimately it is just a framework with actions that are tied to an endpoint and can require certain data fields and perform actions via the OpenStack clients as well as talk to external systems as needed.
Useful for automating generic admin tasks that users might request but otherwise can't do without the admin role. Also allows automating the signup and creation of new users, but also allows such requests to require approval first if wanted. Due to issuing of uri+tokens for final steps of some actions, allows for a password submit/reset system as well.
Documentation
Documentation can be found at: https://docs.openstack.org/adjutant/latest
Documentation is stored in doc/, a sphinx build of the documentation can be generated with the command tox -e docs.
An API Reference is stored in api-ref. This is also a sphinx build and can be generated with tox -e api-ref.