Commit Graph

302 Commits

Author SHA1 Message Date
niuke 91f190cd6a remove unicode literal from code
Change-Id: I44e71499b52873a2350194081f352c12b871c592
2022-07-30 14:32:21 +08:00
Rico Lin 2745a5905f Change primary eamil for Rico Lin
Rico recently change his primary email
from rico.lin.guanyu@gmail.com
to ricolin@ricolky.com

Change-Id: Id26cfce9c14e30c1132234948cb03f99244ae55c
2021-03-05 17:41:16 +08:00
Zuul 81e7685d3c Merge "Add guidelines on Version Discovery" 2020-06-25 16:17:14 +00:00
Zuul 8795075d59 Merge "Add document describing consuming version discovery" 2020-06-25 16:17:12 +00:00
Andreas Jaeger befadaa1b0 Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

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.

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: I30bdb1bf76a12e9562ab461b2701a36f34e770fe
2020-06-03 21:01:11 +02:00
Monty Taylor 31f6575ce4 Add guidelines on Version Discovery
As an expansion of the guidelines around microversions, add guidelines
around how services should expose Version Discovery documents. This
includes recommendations for putting unversioned endpoints into the
catalog.

It also includes a completely new thought, so feel free to punch me in
the head - that versioned discovery documents should include a
collections rel link to allow clients to get from the versioned to the
universioned document without having to do URL manipulation. If we can
get that in, it should serve as a bridge for those clouds that are still
putting versioned endpoints into the catalog for a while for backwards
compat reasons.

Two related follow-up patches are in-work. One that adds a copy of the
consuming-discovery document with all of the extra effort in support of
clouds and services that to not implement these guidelines removed, so a
"perfect future state" is easy to read. The other is a document
recommending a global cloud "profile" that greatly reduces the API
burden on clients consuming this information.

Change-Id: Id8160048dfffc1ada32ce876a65b02fb7a02306e
2020-06-02 13:29:09 -05:00
Monty Taylor e809580088 Add document describing consuming version discovery
The next patch actually describes desired state of version discovery.
But in an epic amount of cart-before-the-horse, we have the process for
consuming the discovery already because the process must take in to account
the present as well as the past. This process has kept in mind what consuming
the recommended discovery process _wants_ to look like in the future and in
calls that out in a few places. The intent would be that the algorithm here
would work for all clouds, but that as clouds and services adopt API-SIG
recommendations, the interactions with the clouds would become more
efficient. (so for clients using the complete algorithm they should be
upwards compatible with forthcoming API-SIG guidelines and will just
naturally do less work over time).

I believe this is consistent in defaults, fallbacks and error conditions with
what is currently implemented in keystoneauth, although there is
additional logic presented here which is not yet in keystoneauth. The
intent is for the process presented here to not change the behavior
experienced by current keystoneauth users, with the exception that when
the complete algorithm is implemented it's possible that an additional
API call may be made on older clouds. That is to say, keystoneauth
should not need to make any incompatible changes, but may need to add
some features to be a fully compliant implementation.

Apologies for the size and complexity. It turns out there are many
historical oddities still lurking out there and advice to client
authors that does not take them in to account would be incomplete. On
the other hand, as we drive guidelines forward into being implemented,
the need for this much crazy logic should go away.

Co-Authored-By: Dmitry Tantsur <divius.inside@gmail.com>
Change-Id: I241f76bca8ac27fc3d27028ae284b9012a2da7e9
2020-06-02 13:23:43 -05:00
Andreas Jaeger 28cce354d9 Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove obsolete sections from setup.cfg
- Update requirements, no need for python_version anymore
- Use newer openstackdocstheme version, update other requirements

Change-Id: I2aec09250c96bc411d19cb6c1a1ee852394d39e5
2020-04-11 14:37:38 +02:00
Zuul 595c36f192 Merge "Verify JSON files in the CI" 2020-03-20 12:45:20 +00:00
Andreas Jaeger 33b57f352a Small cleanups
The default for install_command is good, no need to add our own version
in tox.ini. Remove it.

Remove git commands from conf.py, current openstackdocstheme handles
this itself.

Fix some missed api-wg -> api-sig renames in conf.py.

Change-Id: I806e804a5852e081f0cb8c1b43ffe13a119aba2c
2020-03-19 10:52:23 +00:00
Dmitry Tantsur 393406bbef Verify JSON files in the CI
Change-Id: I88380fe647864e9a7108d5dd76bdf501f289b229
2020-03-19 11:50:29 +01:00
Dmitry Tantsur 3abffb4fd7 Use doc8 to verify rst instead of custom tests
Fix a disproportionally long line in dns-sd.

Change-Id: I9137ce1780e971824bffdd4e6557ddeb44c4db0b
2020-03-19 11:43:16 +01:00
wangfaxin e30aee5906 Fix wrong openstack review link .
Change-Id: I7bcdc10d9e64f96c8320fc1246d07ba92c24dce2
2019-11-20 10:15:20 +08:00
Zuul 634f9a3ea4 Merge "Update to opendev" 2019-09-04 15:59:00 +00:00
Zuul 27bd4e009b Merge "Update liaison for keystone" 2019-05-21 01:21:23 +00:00
Zuul 5fb1837b70 Merge "Add guideline on DNS-based service discovery" 2019-05-17 12:51:09 +00:00
Dmitry Tantsur 19c3c6f566 Update Sphinx requirements and actually use Python 3 for docs
This fixes building the guidelines (again) since Sphinx 2.0.0 is not
compatible with Python 2.7, and the way we use basepython in tox.ini
is not correct (resulting in Python 2 being used by default).

Change-Id: Ieeeb319caa6d7a8dad78857c7dce105da33d2dd2
2019-05-17 09:48:18 +02:00
Colleen Murphy 0d50eba6ad Update liaison for keystone
David Stanek isn't involved in keystone any more, so I am designating
myself as the liaison for keystone.

Change-Id: I2d396c9dad31a041ae86755c2ff3caf26f096bae
2019-05-16 09:14:26 -07:00
Le Hou 28289b4a00 Update to opendev
Change-Id: Icde84212c7008532a97a70fd9f8f768bae0e049b
2019-04-23 13:36:57 +08:00
OpenDev Sysadmins 6ec7b2d2a6 OpenDev Migration Patch
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:33:06 +00:00
Zuul 23f23dad06 Merge "Added Placement to the liaisons file" 2019-04-18 16:38:45 +00:00
EdLeafe efa0dcf2a4 Added Placement to the liaisons file
Added myself as the Placement liaison to the API-SIG. There was also an
empty duplicate section for Nova in the file, so I removed that.

Change-Id: I6701a06b8b0a70a2fe010cbd340ef5e6bc2520a7
2019-04-18 11:18:52 -05:00
Dmitry Tantsur a5a353ced4 Add guideline on DNS-based service discovery
Change-Id: Ia7e136318a9b41b9492a9ee31ff56ddea80732fc
2019-04-09 15:55:54 +00:00
Dmitry Tantsur 2ef2b12a82 Repair building guidelines
The recent yasfb is not compatible with ancient sphinx, just bump
both requirements, as well as replace deprecated oslosphinx with
openstackdocstheme (requirements shamelessly copied from ironic-specs).
While we're here, uncap pbr and bump it to 1.0.

Change-Id: Ia78499827a53f5ee0c7a8b0d9951a0e37dedc91b
2019-04-09 15:55:33 +00:00
Zuul 6cff138b8b Merge "Update the URL in doc" 2019-02-14 16:28:46 +00:00
melissaml 9373885ca1 Change openstack-dev to openstack-discuss
Mailinglists have been updated. Openstack-discuss replaces openstack-dev.

Change-Id: I2ffacbb95feac7295f738ba56c1c1b6c1fd52fad
2018-12-06 16:56:17 +08:00
zhouxinyong 4cb70b4b8b fix some errors for ill-syntax in testing.rst
Change-Id: Ifad024184c40a6e3d1fcb36988e42d564ed0ce93
2018-11-13 10:15:34 +08:00
Doug Hellmann 1d0cbaa46c fix tox python3 overrides
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.

We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.

We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.

Change-Id: I19c77a2604de964672e22780bf0ae8c5874beede
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-09-26 18:48:42 -04:00
melissaml 39a6ebcf40 Update the URL in doc
Change-Id: I15ea0a591ab9dce5f15b9ef9bcce5f6cac9ff4bd
2018-09-23 23:18:24 +08:00
Chris Dent e19e114c80 Add link to Building Protocols with HTTP
In a recent api-sig meeting it was decided that we should link
to this document as a good introduction and commentary on best
practices.

Change-Id: I662ed5c9c21a6eafb74cd1e224bf8c8953a556b6
2018-08-30 18:09:33 +01:00
Chris Dent b6d58a3f7f Explicitly link to the HTTP RFCs
In the opening we advise people to use the HTTP RFCs as the ultimate
authority but do not link to them. This change adds the links and
generalizes the warning to the entirety of the guidelines, not just
to non-JSON apis.

Change-Id: I40a59594a477d6802a16d8b0ca11020629eff292
2018-08-30 18:09:00 +01:00
Doug Hellmann abd46fb0f2 import zuul job settings from project-config
This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project
repository.

Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.

Because this patch is generated by a script, there may be some
cosmetic changes to the layout of the YAML file(s) as the contents are
normalized.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: Id70bf989245c247bdcff0b0cdf0c40e12e58afb8
Story: #2002586
Task: #24760
2018-08-20 16:55:59 -04:00
Chris Dent d7dac9baf9 Update web frontpage to link to SIG not WG
Links to the wiki and git were out of date.

Also update .gitreview to reflect new repository name.

Change-Id: I950604740b7ef8d8ec0b1f97499bdc6e6648db0e
2018-08-06 13:00:44 +01:00
Zuul 0e7f1ae100 Merge "Expand schema for error.codes to reflect reality" 2018-07-26 16:28:52 +00:00
Zuul 8563aebd2a Merge "Add links to errors-example.json" 2018-07-26 16:28:50 +00:00
Zuul 767ea9f5f6 Merge "Switch to stestr" 2018-07-12 16:17:58 +00:00
Vu Cong Tuan bfcbef7e9c Switch to stestr
According to Openstack summit session [1],
stestr is maintained project to which all Openstack projects should migrate.
Let's switch to stestr as other projects have already moved to it.

[1] https://etherpad.openstack.org/p/YVR-python-pti

Change-Id: Iddce63084a10cbc5b1670f42acae6c2ee96e0ce8
2018-07-10 18:40:22 +07:00
Chris Dent 348f499ff5 Expand schema for error.codes to reflect reality
Add '_' as a valid character in error.codes, because that's what's
present in the wild.

The schema is updated to include a pattern check, and one of the
examples is changed to demonstrate the use of the new char.

Change-Id: I6bcfd5d411b2b9c540546f92859647333114a8f8
2018-07-06 16:44:41 +01:00
Chris Dent 777732d9c4 Add links to errors-example.json
They've been TODO for a long time. The provided links are
examples only, but include advice that services should publish
their own error code documentation.

Change-Id: I8e80160abc51ace34e8e286defc9ebe6a7847d54
Story: 1593321
Task: 22178
2018-07-01 18:36:09 +01:00
Chris Dent 8aff4a0149 Expand error code document to expect clarity
Based on conversation in IRC http://p.anticdent.org/282V , update
the errors guideline to be more specific about:

* using specific codes for specific cases
* adding errors is okay and not a breaking-change

Change-Id: I473918ce9c6b49c0b904e93b7140421525f4e7c0
2018-07-01 18:28:45 +01:00
chenjiao ff8fbbf3a9 spelling error
the word verison should be verision

Change-Id: Ib118345a14cdf3174be7b6dc9a4ce889561416e0
2018-06-17 14:26:49 +08:00
XiaojueGuan 028d37d986 Trivial: update url to new url
Change-Id: I3f5bd7b97787031cb79a8c30c39703a016e2d239
2018-05-13 21:25:46 +08:00
Zuul e7644e98f5 Merge "Add guidance on needing cache-control headers" 2018-04-26 16:24:24 +00:00
Zuul f70b2ee543 Merge "Remove use of Python builtin name for variables" 2018-04-23 14:49:31 +00:00
Chris Dent b585c8485d Add guidance on needing cache-control headers
This adds some practical guidance to the existing section on caching
to make it clear that where responses are not making explicit
assertions about controlling cache, they MUST "cache-control: no-cache"

Change-Id: If13a5a19ff077cd9a2c9c400c24af70ea6f818d9
Closes-Bug: #1747935
2018-04-12 21:47:22 +01:00
Chris Dent f094748e92 Update the errors guidance to use service-type for code
Also, explain a bit about why errors exist and how the code
can be used.

Change-Id: Idcb4d11f7ff9867dfe29b47dcfd9774ed269ab3e
Closes-Bug: #1756464
2018-04-12 20:36:46 +00:00
Ed Leafe 6ad31a4923 Remove use of Python builtin name for variables
'file' is a Python builtin name, and should not be used for a variable
name.

Fixes-Bug: #1763469

Change-Id: Ifb0a3fe51f995cee5d703be23ea444da3e837be6
2018-04-12 17:55:07 +00:00
Ed Leafe e3d4507d10 Fix the checking of directories for extensions
The test for file extensions was checking everything returned by
glob.glob("guidelines/*"). The recent merge of the refactored HTTP
guidelines added a new guidelines/http/ directory, and the test was
failing because that entry didn't end with either .rst or .json. This
patch corrects that by skipping directories from that name check.

Change-Id: I0a84160015e9c1d96cb456b07c5e45fc6645df08
2018-04-12 17:40:40 +00:00
Ed Leafe f0651255f8 Break up the HTTP guideline into smaller documents
The current HTTP guideline is very, very large. It will be more easily
discovered and consumed by breaking it up into logical chunks.

Co-Authored-By: Dmitry Tantsur <dtantsur@redhat.com>
Change-Id: I964b1f31e50c93f59e5dc07d7643c6c21b51f762
2018-04-05 15:38:28 +02:00
Zuul fbd6d9abcc Merge "Add guideline on exposing microversions in SDKs" 2018-03-29 16:48:37 +00:00