Commit Graph

432 Commits

Author SHA1 Message Date
Tony Breeds 1fe1e0e38e Retire Packaging Deb project repos
This commit is part of a series to retire the Packaging Deb
project. Step 2 is to remove all content from the project
repos, replacing it with a README notification where to find
ongoing work, and how to recover the repo if needed at some
future point (as in
https://docs.openstack.org/infra/manual/drivers.html#retiring-a-project).

Change-Id: I61c76fb6f2868ba5c1bd73493adf676288809449
2017-09-12 16:06:43 -06:00
OpenStack Proposal Bot 864042c23e Updated from global requirements
Change-Id: Id1100b5b4359cb38dc4095320a315829d30e4383
2017-07-18 01:54:59 +00:00
Jenkins f62fd2b499 Merge "Fix parsing bug when config file is empty." 2017-07-13 11:41:50 +00:00
Jenkins f7741521ac Merge "sphinxext: Use field lists in output" 2017-07-13 11:41:44 +00:00
Jenkins 6d43226d91 Merge "sphinxext: Format definition lists correctly" 2017-07-13 11:41:38 +00:00
ChangBo Guo(gcb) 3fe7d8e474 Update URLs in documents according to document migration
Change-Id: I7c9a0cef77d8564b8c6f0513da985b8ed0a404b9
2017-07-12 23:01:31 +08:00
TommyLike 7c3621dafe Fix parsing bug when config file is empty.
Method 'parse_file_contents' is expected to return
dict object after parsing the policy file, but
it will return None if file is empty currently.
Fix it.

Change-Id: I2841ccdb0f657fdb583e94d889cdd2685d7068b4
2017-07-12 16:47:38 +08:00
Jenkins 5d76e78009 Merge "switch from oslosphinx to openstackdocstheme" 2017-07-05 14:20:15 +00:00
Doug Hellmann 9d018cd64c import configuration guide content from openstack-manuals repo
Change-Id: I0d801ee399331dfcd5d0bdcae678d14ef44e5b2f
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-05 11:26:08 +00:00
Stephen Finucane 9697fede88 sphinxext: Use field lists in output
The 'sphinxext' module provided by 'oslo.config' uses field lists [1] for
its defaults. Provide some cross-promotional, deal mechanics, revenue
streams, jargon synergy between these two plugins (i.e. make them look
similar).

This message was approved by Jack Donaghy [2].

[1] http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists
[2] https://youtu.be/aocZo3oeNxw

Change-Id: I6e478152a278a877ae37588be930b0b833eb09cd
2017-07-05 11:05:23 +01:00
Stephen Finucane b6aaf0094a sphinxext: Format definition lists correctly
In a definition list, a term must be immediately followed by an
(indented) definition. However, the current implementation added a
newline resulting in a paragraph followed by a blockquote. Resolve this
oversight.

Change-Id: If8dae36885be23b1784b8b1d7015b92bb630abbe
Closes-Bug: #1702442
2017-07-05 10:46:57 +01:00
Doug Hellmann 0401f57d49 switch from oslosphinx to openstackdocstheme
Change-Id: I3a35af82ff83946e30f00171bd50c2eac7b9d0a5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-28 16:46:41 -04:00
Doug Hellmann 88a104d852 move existing documentation into new standard layout
Change-Id: Iaefc26222d42663423f736946dea97c5613b7d1c
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-28 16:46:38 -04:00
OpenStack Proposal Bot ded939ba71 Updated from global requirements
Change-Id: I9badce163f0f2b7b01ea8d9436ef6db67fe561d5
2017-06-27 12:20:20 +00:00
OpenStack Proposal Bot 04c3063aa3 Updated from global requirements
Change-Id: I91e2b2df6e86ebf6bee02390e8c96f4ed95ecc04
2017-06-15 16:33:03 +00:00
OpenStack Proposal Bot b5beeb645e Updated from global requirements
Change-Id: I1eceb9d8e5511fd90f2433ad66411a7d0729fb88
2017-06-10 21:46:54 +00:00
OpenStack Proposal Bot e1549ff1ba Updated from global requirements
Change-Id: I649936d45e36b7e58d3e38f8936aa297d0d0524d
2017-06-02 22:05:26 +00:00
OpenStack Proposal Bot b4be783c23 Updated from global requirements
Change-Id: Iec0d81fc4369a7ca723811d051aa34076c0d2af6
2017-06-02 02:35:09 +00:00
Jenkins deffa995a6 Merge "Simplify message of exception PolicyNotAuthorized" 2017-05-24 20:21:56 +00:00
OpenStack Proposal Bot 2a8d18adde Updated from global requirements
Change-Id: I022c69ec40b2f4744c2907233e9ae5425520416c
2017-05-23 12:27:37 +00:00
Jenkins c8cf1056d7 Merge "Add Sphinx extension to pretty-print modules" 2017-05-23 11:58:05 +00:00
ChangBo Guo(gcb) 4cc14178ef Simplify message of exception PolicyNotAuthorized
The message is a string, and target and credentials are dicts. Not only
do they make the message very ugly and hard for a human to parse, but
they are giving information that is typically unnecessary and won't be
understood by most users.

Closes-Bug: #1673859

Change-Id: Iabd7d6ebb0fda1c631bb219846643a065fa4fb31
2017-05-23 10:47:32 +08:00
Jenkins 6da8fe15be Merge "Check reStructuredText documents for common style issues." 2017-05-22 21:55:56 +00:00
OpenStack Proposal Bot 1a34590efb Updated from global requirements
Change-Id: Icd75dfdbb6a67322eba158be4a495bdfafca0fb2
2017-05-17 03:56:44 +00:00
OpenStack Proposal Bot 6715695f01 Updated from global requirements
Change-Id: I4de956d302b387697ea79c14784e2a5df28efa9e
2017-05-15 00:53:01 +00:00
Stephen Finucane 2320ee61a3 Add Sphinx extension to pretty-print modules
This will provide a more parsable sample policy file for us in docs.
This compliments the 'sphinxpolicygen' module.

Change-Id: Id99b21e7c0a66aaf4223e60074626914235e0ca5
2017-04-27 15:10:25 +01:00
loooosy a7ab49e42c Optimize the link address
Use https instead of http to ensure the safety without containing our
account/password information

Change-Id: I07f0af54f8cbcfd2100d55415b5b1c6dec32f3d4
2017-04-08 23:36:11 +08:00
ZhongShengping 08a38fa389 Check reStructuredText documents for common style issues.
Change-Id: Iaeb9e556cd634134b27a93b1fb7ad8fc2e24e93c
2017-03-24 10:45:09 +08:00
Jenkins ee8e96a35b Merge "Remove log translations" 2017-03-23 15:56:58 +00:00
Jenkins 5bd5f34b59 Merge "Update usage documentation" 2017-03-22 21:47:43 +00:00
Lance Bragstad 51af4de284 Update usage documentation
We recently merged a patch that enhanced the RuleDefault object by
allowing it to have more attributes:

  Ie9b335420394166bb39c43e3d26fcc9237ffd1a0

This commit describes its usage in the usage documentation.

Change-Id: I8f6e6bc289a046b09529f707874314c69757ee11
2017-03-22 19:27:11 +00:00
Jenkins ac8fa40893 Merge "Add release note for DocumentedRuleDefault" 2017-03-22 17:51:47 +00:00
Anthony Washington 03e4352d6b Add release note for DocumentedRuleDefault
This patch adds a release note for changes made here[0].

[0]: Ie9b335420394166bb39c43e3d26fcc9237ffd1a0

Change-Id: I0ffbc069e86f0d3df41d1bb3840977990b8cac56
2017-03-22 15:02:13 +00:00
loooosy 5d461fae60 Remove log translations
Log messages are no longer being translated. This removes all use of the
_LE, _LI, and _LW translation markers to simplify logging and to avoid
confusion with new contributions.

See:
http://lists.openstack.org/pipermail/openstack-i18n/2016-November/002574.html
http://lists.openstack.org/pipermail/openstack-dev/2017-March/113365.html
Change-Id: I1201cab3686a3689c4d24d6da4ddef87fcd04f13
2017-03-22 14:13:15 +00:00
Jenkins 0f10c1aaa3 Merge "oslopolicy-sample-generator description support" 2017-03-21 12:55:58 +00:00
Anthony Washington c4ea173b81 oslopolicy-sample-generator description support
With the idea of adding a more descriptive policy rule so
operators can understand what a policy rule controls. This
patch ensures `oslopolicy-sample-generator` adds the
api(s) and method(s) {if given} to policy description.

Change-Id: If4ca9bc191ac263f861373c432a1fafc3f7d596e
2017-03-20 21:17:09 +00:00
Stephen Finucane 886d8c6dab Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section.  Migrate the
setting from the old warnerrors one.

There are some invalid docstrings. These are cleaned up.

Change-Id: Ic6a028bab428b23255f36e5b2d64ee8d4d32978d
2017-03-20 10:11:47 +00:00
Anusha Unnam 3951771456 Comment out the rule from generated sample-policy file
blueprint policy-docs

Change-Id: I8077f15c6b231b13c3f96ed5325795958c2cb75f
2017-03-17 21:19:29 +00:00
Anusha Unnam bb33bf3a6d Modify tests in test_generator
This change is needed to comment out rule from the generated
sample-policy file. Added new parameter 'include_help' to
_generate_sample method and changed the tests accordingly.

blueprint policy-docs

Change-Id: I6883f248dcd6ec4829e684210c2de44863431df7
2017-03-17 18:58:55 +00:00
Jenkins d4ed4a09a7 Merge "Add additional param to policy.RuleDefault" 2017-03-16 01:34:48 +00:00
Anthony Washington a95606c1df Add additional param to policy.RuleDefault
This patch adds the needed subclass to define policy objects
that now require the description and operations parameters.

The operations parameter when defining a policy rule should follow
the below format.
    - operations : list of dicts containing the api url and verb.
        Ex : operations=[{path='/some/url/', method='GET'}]

This change make sure operators have all the information needed
in a centralized location in order to make decisions and understand
the purpose of a certain policy.

Change-Id: Ie9b335420394166bb39c43e3d26fcc9237ffd1a0
2017-03-15 21:09:37 +00:00
OpenStack Proposal Bot b2d6455ad7 Updated from global requirements
Change-Id: I0a6fa7102dcfef90f141c174eb7a243f10a1930f
2017-03-15 04:26:36 +00:00
Anusha Unnam d071de9c2b Seperate each policy rule with new line
Changed generator code to add new line at the end of each policy,
so that it would be easier to read. This change is required for
implementing this spec https://review.openstack.org/#/c/433010/

blueprint policy-docs
Change-Id: Ie85516b2741c94bab6e9bcd65f92ce38cb250fc6
2017-03-13 18:19:43 +00:00
Sujitha 8ca44b38bd Allow multiline descriptions for RuleDefaults
Multiline descriptions are not displayed properly in the generated
sample file because of the wrapper used.

This patch changes the formatting of help text by wrapping each
line.

Change-Id: Ic19a06189caa0002458881c543c63c7540e301de
2017-03-06 23:02:50 +00:00
OpenStack Proposal Bot 3c3261c072 Updated from global requirements
Change-Id: I5ce59cfc43b51e5cc27f16844c5375a22825ad62
2017-03-03 03:07:08 +00:00
ricolin db43505285 [Fix gate]Update test requirement
Since pbr already landed and the old version of hacking seems not
work very well with pbr>=2, we should update it to match global
requirement.
Partial-Bug: #1668848

Change-Id: Ia07952992bd90213ed9ad9b0adaa7a47553708f7
2017-03-02 18:29:40 +08:00
OpenStack Proposal Bot 0a5112c26d Updated from global requirements
Change-Id: I53ee1c69ec2c3b3c65cc76ce7a8d7af983675342
2017-02-11 17:50:32 +00:00
OpenStack Proposal Bot 5aad32b5f3 Updated from global requirements
Change-Id: I0b7cf1597fc844d698d2711058ead291ac692769
2017-02-10 05:57:48 +00:00
Jenkins 7fab5c9dad Merge "Remove support for py34" 2017-02-08 13:41:47 +00:00
gengchc2 f92a276c27 Remove support for py34
The gating on python 3.4 is restricted to <= Mitaka. This is due
to the change from Ubuntu Trusty to Xenial, where only python3.5
is available. There is no need to continue to keep these settings.

Change-Id: I1ce696484f3f1c07a08fb9bde51d2c8ac26cc7be
2017-02-08 16:03:11 +08:00