History

Ghanshyam Mann 0cc7cbc36d [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 convert manila/tests/policy.json to manila/tests/policy.yaml
using oslopolicy-convert-json-to-yaml tool and 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: I3748313912b2527c43c9b16a6ba3e3ccd4cf5221

2020-12-13 00:05:00 +00:00

ext

doc migration: openstackdocstheme completion

2017-08-24 09:15:18 -04:00

source

[goal] Deprecate the JSON formatted policy file

2020-12-13 00:05:00 +00:00

README.rst

Update the documentation link for doc migration

2017-07-14 07:27:16 +00:00

requirements.txt

Use unittest.mock instead of mock

2020-06-09 01:21:20 +02:00

README.rst

Manila Development Docs

Files under this directory tree are used for generating the documentation for the manila source code.

Developer documentation is built to: https://docs.openstack.org/manila/latest/

Tools

Sphinx: The Python Sphinx package is used to generate the documentation output. Information on Sphinx, including formatting information for RST source files, can be found in the Sphinx online documentation.
Graphviz: Some of the diagrams are generated using the dot language from Graphviz. See the Graphviz documentation for Graphviz and dot language usage information.

Building Documentation

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs