Commit Graph

20 Commits

Author SHA1 Message Date
Ghanshyam Mann 5ef2e7b8a5 [ussuri][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: #38522
Change-Id: I16738f205ae235d9d8af2e54395d7decefded7d0
2021-05-31 20:30:51 +00:00
Ghanshyam Mann e02a492817 [goal] Deprecate the JSON formatted policy file
As per the community goal of migrating the policy file
the format from JSON to YAML[1], we need to do two things:

1. Change the default value of '[oslo_policy] policy_file''
config option from 'policy.json' to 'policy.yaml' with
upgrade checks.

2. Deprecate the JSON formatted policy file on the project side
via warning in doc and releasenotes.

Also replace policy.json to policy.yaml ref from doc.

[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html

Change-Id: I066488c47e1bb6502b27b8677988113f66b9b09b
2021-03-08 19:52:30 -06:00
liyou01 9ce1a11451 remove unicode from code
Change-Id: Ie452dbdd42ec7ef34993572ac0b456562aabab79
2021-01-07 14:37:16 +08:00
Zuul ddf9eaed0a Merge "Fix pygments style" 2020-07-21 07:30:41 +00:00
caihui b66bfa0365 Overriding configured project name (freezer-api)
[openstackdocstheme] overriding configured project name (freezer-api) with
name extracted from the package (freezer-api); you can disable this
behavior with the 'openstackdocs_auto_name' option

Change-Id: Icbe9ceff6ad25dc353a3c574f32b26bc007c7294
2020-07-05 20:36:40 -07:00
caihui b744d68b64 Fix docs output error
writing output... [ 33%] cli/freezer-manager-status
[openstackdocstheme] the 'repository_name' config option has been deprecated
 and replaced by the 'openstackdocs_repo_name' option; support for the former
 will be dropped in a future release
[openstackdocstheme] the 'bug_project' config option has been deprecated and
replaced by the 'openstackdocs_bug_project' option; support for the former
 will be dropped in a future release
[openstackdocstheme] the 'bug_tag' config option has been deprecated and
replaced by the 'openstackdocs_bug_tag' option; support for the former will
be dropped in a future release
writing output... [ 66%] cli/index
writing output... [100%] index

Change-Id: I55903e4f914673aba5ac986b845c2a6504830c19
2020-07-05 20:16:46 -07:00
gugug 11abfacbb8 Fix pygments style
New theme of docs respects pygments_style.

more info: http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I4dc7389756a4bfd6da62841456bf1653637b0371
2020-05-21 01:23:45 +00:00
Andreas Jaeger f5332fd0d1 Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Update requirements, no need for python_version anymore
- Switch to using sphinx-build. Remove extra build step
  from docs build - api-ref is build separate.
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine

Change-Id: I7bb95a8ebd7023046baae30595159254bac25690
2020-04-13 16:41:33 +02:00
Michal Arbet 2a283bf34a Fix freezer-api's src_file to path_to_backup
Freezer-api is not working as it is expected, returning NULL value
for src_file option in freezer_action's json returned from API.

In other words when user define action via freezer client and define
valid and WORKING action JSON with option path_to_backup
(src_file is not supported by freezer-agent anymore).

In DB we can see backup_metadata is filled correctly,
freezer-scheduler/freezer-agent working correctly as they are reading
backup_metadata. Problem is that API is still returning json with
src_file set tu NULL because src_file is not present in backup_metada,
therefore is not filled in src_file column in action table.

Src_file option was changed to path_to_backup in freezer git repository
below, but API was never changed, this patch is fixing this behaviour.

Freezer's change :
c7f71ff70b

Doc changes in freezer:
https://review.opendev.org/#/c/705003/

Change-Id: I9e74910bd0ff4ad18b830c26ce90770b0dfa107b
2020-01-31 11:45:39 +01:00
caihui 90c826844d Update README.rst Doc
Update "README.rst"  to support "sqlalchemy" .

Change-Id: I63225a660004a3c4cd6efe6d794cb3f12d2476c9
2019-11-19 03:07:15 -08:00
Sean McGinnis d2768ec7a4 Switch to openstackdocstheme
oslosphinx theme is being retired as it is not compatible with the
recent Sphinx 2.0 release. This switches docs and release notes to use
the openstackdocstheme instead.

Change-Id: Ifc544d5d4ca9389a3a73d95397c6489fcab9d509
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-04-04 09:30:45 -05:00
gengchc2 cdd34ec059 Add search option for list query
Change-Id: I3a2f021f5d9e104539fc1550713553f6c86df553
2018-11-29 08:47:09 +00:00
whoami-rajat 88ce38ca10 Add freezer-manager-status upgrade check command framework
This adds basic framework for freezer-manager-status upgrade
check commands. For now it has only "check_placeholder"
check implemented.
Real checks can be added to this tool in the future.

Change-Id: I21d4c7ff5e659b332d6692352d996b3216b56bc9
Story: 2003657
Task: 26129
2018-10-29 01:33:41 +00:00
wangqi bdb6513b0f Update links in README
Change the outdated links to the latest links in README

Change-Id: I7eec91ba115e75bb7ef866d1b5ed2587c104300b
2018-03-02 05:57:49 +00:00
Saad Zaher 84fa303f68 Update freezer-api README.rst
Change-Id: I2b94315751cddd8e977d6be094dd0188e66c8bb5
2018-02-20 15:37:04 +00:00
yfzhao 74164f0f4f TrivialFix: Remove the unused import code
Remove some unused import code in doc/source/conf.py

Change-Id: Idf463219451d4fca767edd747ca3be815053b87a
2017-08-04 09:28:40 +08:00
Vu Cong Tuan 9035a32cf9 Fix html_last_updated_fmt for Python3
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Changing Popen to .check_output because of 2 reasons:
1. check_output() will raise CalledProcessError if
the called process returns a non-zero return code.
2. For consistency with keystone [1] and cinder [2]

[1] https://review.openstack.org/#/c/457142
[2] https://review.openstack.org/#/c/433081

Change-Id: Ie5fc71b2d9e53a0beef86d411da1d680cccf3dd2
2017-06-09 11:21:10 +07:00
Andreas Jaeger 15233f9bf3 Docs: Various fixes
Treat warnings as errors when building documents to early spot problems.

Fix api-ref set up:
* Add openstackdocstheme for api-ref building instead of oslosphinx and
  configure it properly.
* Setup api-ref log-a-bug correctly for this project.
* Remove unneeded extra install command

Fix install-guide set up:
* Add tox environment

Fix releasenotes set up:
* Fix conf.py settings to build without errors, remove index, we don't
  need it.

fix docs set up:
* Use Sphinx 1.5 warning-is-error option for normal build_sphinx.
* use oslo sphinx
* Remove wrong static path setting

Change-Id: I07ce9db9fdb526ab4b083c65afa99c38bb508146
2017-03-08 21:02:46 +01:00
Rajiv Kumar c4c1e213cf Remove link to modindex
The documentation build does not generate any module index, thus
remove the link to the page.

Change-Id: I7508fc6025f86fd1ef50ac372c35e7a8f0a8a056
2017-01-27 10:19:08 +05:30
Fausto Marzi e89b5fc80e Add Sphinx doc build
Change-Id: I06391e714c94b2308b2ce20ba503cb5773bf829e
Closes-Bug: #1542061
2016-02-06 21:13:11 +00:00