Commit Graph

12 Commits

Author SHA1 Message Date
sunjia 7b47a2a7a4 Generate PDF documentation
For PDFLaTeX, remove the irrelevant parts (contributing,
search) and those that break (full config examples).
Additionally, this replaces fancy quotes as they don't work
in PDFLaTeX either (it handles regular quotes internally).

Change-Id: I60459407e49a88c2231217152fc078346e5f4b4f
Co-Authored-By: Radosław Piliszek <radoslaw.piliszek@gmail.com>
2021-08-17 16:42:09 +00:00
Zuul 6b9561935b Merge "[community goal] Update contributor documentation" 2021-06-05 14:20:48 +00:00
Ghanshyam Mann 44cae8ad7f [community goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38536
Change-Id: I1d8ff80322deffb904d1bfe16b5a5ad9d4d9fc07
2021-05-31 20:33:51 +00:00
Radosław Piliszek 9aad73d21c [docs] Add "release notes" contributors' section
This should help us write better release notes (or write them
at all in the first place :-) ).
This is an adaptation of the work I have done for Kolla in [1].

[1] https://review.opendev.org/c/openstack/kolla-ansible/+/759254

Change-Id: I60ff41d721117a9e973c02e3e2a2fdf6550960a7
2021-02-27 19:00:10 +01:00
Jegor van Opdorp 5caad48713 [docs] Add docs on code structure
Additionally restructures the contributor guide.

Change-Id: I869e00b214cacb0dc223e962201944d3ce13526c
Co-Authored-By: Radosław Piliszek <radoslaw.piliszek@gmail.com>
2021-02-27 18:40:36 +01:00
Shilpa Devharakar 596b3d142e Reorganize masakari documentation
Updated operator guide documentation for
1. segregated sections appropriately
2. referred masakariclient for CLI section
3. added detailed 'Install and configure for Ubuntu' section
4. added detailed 'Verify operation' section
5. used sphinx-build instead of the pbr sphinx extention for building docs
   as instructed by the PTI[1]
6. cleaned up build_sphinx related entries in setup.cfg

[1]: https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation

Change-Id: Iec93bebdbc7ffe1ccd27bb11f474384ff06a559c
2019-10-11 01:32:08 +00:00
Kengo Takahara 0616b4bd99 Send notifications for all API changes
This patch send notifications for all API changes.
1. Segment: create, update, delete
2. Host: create, update, delete
3. Notifications: create, update

Co-Authored-By: Shilpa Devharakar <Shilpa.Devharakar@nttdata.com>

Change-Id: I02411db0b3563f6a24e164dbaf50bb30744c2fda
Implements: bp notifications-in-masakari
2019-03-05 10:46:23 +05:30
akhiljain23 7700cdd3bf Add framework for masakari-status upgrade check
This commit adds the functionality of masakari-status CLI for performing
upgrade checks as part of the Stein cycle upgrade-checkers goal.
It only includes a sample check which must be replaced by real checks in
future.

Change-Id: I17c79af15eca5f6da7e32dbedbdc392c97114d42
Story: 2003657
Task: 26140
2018-11-08 13:19:06 +00:00
bhagyashris ad3dc737c9 Add hooks for recovery method customization plugins
This change adds hooks for pulling in plugins for
Interoperable recovery method customization taksflow
by configuring the actions in terms of execution order,
extra parameters to execute commands in action.

Implements: blueprint recovery-method-customization

Change-Id: I8150935ce0a4e592bd0f87bb3c7b3e599cefa033
2018-08-02 13:13:00 +05:30
Abhishek Kekane fa0e35dc29 Masakari operator's documentation
Added overview of masakari, sample configuration and policies
required for masakari.

Change-Id: If81e92dbdaa4bd9869b7e60d5aaf313532c25676
2017-11-27 05:31:21 +00:00
Abhishek Kekane c54d45f5db Masakari developer's documentation
Added documentation for how to get involved, development qucikstart
and masakari system architecture.

Change-Id: Ie2cbdde7698a79a1b996e485d141eb15dbded4cd
2017-11-27 05:31:13 +00:00
sampathP b59503d7aa Initial Cookiecutter Commit.
Change-Id: I42dea4c1d43a041cfd948703355ce7456c8850e1
2016-06-28 13:28:27 +09:00