The contents of this repository are still available in the Git source
code management system. To see the contents of this repository before it
reached its end of life, please check out the previous commit with
"git checkout HEAD^1".
For any further questions, please email
openstack-discuss@lists.openstack.org or join #openstack-telemetry on OFTC.
Change-Id: Ic8a7001e708d8da7cf8951eefd0a96762ea5fa46
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 and tests.
[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html
Change-Id: Ie6e22b0b47c5148290f7b76c95967cd9a343343c
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Disable openstackdocs_auto_name to use 'project' variable as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
Remove docs requirements from test-requirement, it's enough to have them
in doc/requirements.txt.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I8d4234212ecceb639e40eae423af72d2d08b010d
Cleanup docs building:
- Remove obsolete sections from setup.cfg
- Switch to using sphinx-build
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version, use apidoc for
API docs
- Fix doc problems found
Change-Id: I1f92444a145030e7715a8d357870d712c5d3cfb1
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:
* Wheel is not needed for python 3 only repo
* Some other sections are obsolete
- Update classifiers
- Update requirements, no need for python_version anymore
Change-Id: I551d8eada6764516dd0612037d9e9e9e5a677347
this isn't referenced anywhere and was removed a while ago in
ceilometer docs
Change-Id: I871c87e19b2dc09770830cda80aac586f90dd429
see: I3a50edaf12921684e8c8bd070a2b7dbfee4311fd
This is the final bit to implementing the policy goal for Panko.
This just ensures the policies registered in code are actually
rendered in documentation and up-to-date.
Change-Id: I5c97263b84695c0a83dc82782d2f8861dca8ced5
This isn't actually used and is a leftover from a thing we did
seven years ago that survives today through copy-pasta.
Change-Id: Ice0ae152059f8ebdba76049a1f09534efe46bdca
Project documents are being reprocessed due to document migration[1].
Update the docs theme to openstackdocstheme instead of oslosphinx.
[1] https://review.openstack.org/#/c/472275/
Change-Id: I9353ba579b093d0ab91e2f60612b8cbc8ffbb733
Co-Authored-By: chenxing <chen.xing@99cloud.net>
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.
Change-Id: I1b494829e6d57764938e290f44cd9ba08adc3fc5
The current setup.py install comand copies all config files
to /etc/panko, so this step is not needed anymore in the
manual install guide.
Change-Id: I0f2886ffd08852712434a4257fb1797287cbc44a
Signed-off-by: csatari <gergely.csatari@nokia.com>
Our legacy database doesn't provide alarm capability any more,
however, there is a table in document still mentions it.
Also update this table for hbase statistic limitation.
Change-Id: I195106b23024a289196d9b5ec7cc891f251040e4
openstack role create requires a positional argument name, not optional.
also this patch removes endpoint trailing /, it is redundant and I still
remember once ago there is a bug reported for such issue, which leading
to urls like http://localhost:8777//v2/meters: double slashes
Change-Id: I973a3f60d8bd8f2bc4f8aa9f19c2ce47cd8b8f18
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.
Change-Id: I992f38ba935536c59217e22d4071f40a69090fc2
Closes-Bug: #1552251
the docs are a bit wordy in some places. our docs are confusing
enough:
- remove notification > polling in architecture page
- remove redundant Events filtering from event_types
- move shuffle/batch options to customisation page
- add http publisher
- remove db choices from architecture page, point to dbreco page
- remove db background referencing single database route
- remove warnings to say db might change, use api (obvious)
- remove stuff about Ceilometer is part Openstack but not tied to it
- move hbase configuration under common hbase section in install
- remove tox compatibility comments since it's > 2 years
- remove random non-devstack/historical text from devstack page
- remove default cinder/nova configurations from devstack page
Change-Id: Ifdbeee358cfcb5d3736608e39067ff2859cc0ed6
Matthias Runge