34 Commits

Author SHA1 Message Date
Zuul
1c2191bf3a Merge "Add plugin doc page for cyborg" 2022-12-20 15:03:25 +00:00
Zuul
1d96a899f8 Merge "docs: Fix typos" 2022-12-20 13:20:13 +00:00
Shogo Saito
7f89b109cf Add plugin doc page for cyborg
This patch add cyborg (accelerator) doc page.

Change-Id: I0f3e5419ce522e620be805c0fcd829c8dfb2e317
2022-12-20 12:33:00 +00:00
Stephen Finucane
4cf22b3d76 docs: Fix typos
Change-Id: I902e8b35d4423f91dd8cdeecbcc7e60af877da75
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2022-12-05 10:18:56 +00:00
Stephen Finucane
199ba0bcf8 docs: Document how we manage API versions
Document that microversion auto-negotiation is acceptable. Heck, it's
downright desirable.

Change-Id: Ib256e064d1e8b6dc8273e482276dce243f9991cb
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2022-11-30 12:07:33 +00:00
Stephen Finucane
bb5b290478 docs: Describe common actions found in OSC
Off the back of a recent post to openstack-discuss [1], list the common
actions used in OSC along with some conditions around their expected
use and implementation.

[1] https://lists.openstack.org/pipermail/openstack-discuss/2022-November/031284.html

Change-Id: Id6610d678e7b3b12afdd89a674fbbe7090f64444
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2022-11-30 12:07:33 +00:00
Stephen Finucane
948198643f docs: Typo fix
Change-Id: I2d55747b1226207946f80f04b80b4685e3eea3f9
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2022-11-25 17:28:50 +00:00
Stephen Finucane
abf1a7cc4b docs: Small cleanup of human interface guide
Before we add more content.

Change-Id: I6cf28bdd217326db991466a21221b685124d4b99
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2022-11-24 13:02:10 +00:00
ryanKor
c0a0f0f3d8 Fix that the path of functional test
before change:
$ tox -e functional -- --regex functional.tests.compute.v2.test_server
after change:
$ tox -e functional -- --regex tests.functional.compute.v2.test_server

the test unit path document should be change the above line.

(fixed wrong letter)

Change-Id: I49674fb0d56ee65c1f6328b9d960b16876173e2d
2021-09-25 21:34:47 +09:00
Stephen Finucane
87e6828678 Add pre-commit
This is helpful to automate code style checks at runtime. We include
documentation on how to run this as well as a general overview of style
guidelines in OSC.

Change-Id: I2dc5a0f760ce53269ae25677560b2611cc6bfd91
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2021-03-11 16:20:15 +00:00
Takashi Kajinami
791bed6dd2 Update the file paths mentioned in README.rst
This change fixes the outdated file paths, which were renamed by commit
9599ffe65d9dcd4b3aa780d346eccd1e760890bf .

Change-Id: I9ec4c49711a2fde24f5527086e495c86af9ef1ce
2021-03-15 23:29:53 +09:00
Stephen Finucane
d33eb3e1da Remove retired Karbor support
The Karbor project is being retired in Wallaby [1]. Remove the docs for
its client.

[1] http://lists.openstack.org/pipermail/openstack-discuss/2020-November/018643.html

Change-Id: I52d0f6a76cc9bcfc8b33f0e2cd3751859770ac8a
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2021-01-08 18:43:05 +00:00
Ghanshyam Mann
a79e7db4ae Remove retired Searchlight support
Searchlight project is retiring in Wallaby cycle[1].
This commit removes the support/usage of Searchlight project
before its code is removed.

Needed-By: https://review.opendev.org/c/openstack/searchlight/+/764526

[1] http://lists.openstack.org/pipermail/openstack-discuss/2020-November/018637.html

Change-Id: Idad97343b9ce66186d50ee0560a2fded66655f9b
2020-12-08 19:48:54 +00:00
Stephen Finucane
0a7f2692c6 Remove references to Python 2.7
We don't support it anymore. This is just noise now.

Change-Id: I3640e7d8e520db69f83f95e9c7759279f7c15008
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2020-11-05 14:15:37 +00:00
Stephen Finucane
5f650853f7 Remove references to setuptools
Newer versions of cliff and stevedore use importlib rather than
setuptools to work with entry points. Replace any references to
"setuptools' entry points mechanism" with "Python's entry points
mechanism".

Change-Id: Iae36155685ee37ab5e38a0c173110a5ece33d05d
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2020-10-22 09:52:57 +01:00
songwenping
c2df9215e1 Remove usage of six
With python3.x, classes can use 'metaclass=' instead of
'six.add_metaclass', 'six.iteritems' and 'six.iterkeys' can
be replaced by 'items' and 'keys', 'six.moves.urllib.parse'
can be replaced by 'urllib.parse', 'six.StringIO' and
'six.moves.cStringIO' can be replaced by 'io.StringIO',
'six.text_type' and 'six.string_type' are just 'str'.

Change-Id: I84848c0bf8ab3c36dd821141191e2725e4e3b58b
2020-10-07 02:15:25 +00:00
likui
f0642bc05f Update developing.rst
Use unittest.mock instead of mock

Change-Id: Ib573e9d217b4f18ef4e7ba3ab581164be423cb26
2020-09-08 15:44:51 +08:00
Andreas Jaeger
b5389dab02 Remove congress
Congress and python-congressclient have been retired and also
removed from global requirements, thus requirements-check job fails.

Remove congress from this repo.

Change-Id: Ibf68fee49e69264a1c46b2f456901d2620befe3c
2020-06-04 18:29:49 +02:00
Zuul
da7226a556 Merge "Update the content about Import Format" 2020-03-20 17:07:24 +00:00
Kendall Nelson
27b16df7f8 Remove mention of meetings from docs
Since the OpenStackClient team doesn't meet anymore, I removed
the mention of meetings and added mention of the IRC channel in the
communication section of the docs..

Change-Id: Iefa95878f95bf84bd9fc22ea4c914effc30dffa7
2020-01-28 05:54:20 +00:00
Eric Fried
8cdc7348d1 Add placement to known plugins
Add the osc-placement project (osc plugin for the placement service) to
the list of known plugins.

Change-Id: I77b614b38ecf872d0d93473b834994913930b76f
2019-10-21 16:11:09 -05:00
Witold Bedyk
01eeed28f7 Remove python-ceilometerclient
Project is retired [1].

[1] https://github.com/openstack/python-ceilometerclient

Change-Id: Idc3a340c99c9fd79d80c90e45fd9a1c44c205218
2018-09-28 16:08:49 +02:00
Witold Bedyk
424ab43a0e Add monascaclient to not plugins list
Change-Id: I377a018a4e3c7b6fa44ce9323d1ee2edbd0e4728
2018-09-28 10:45:17 +02:00
zhang.lei
dbff17d720 Add cliff project link
Change-Id: I6a964781667aa92f4b8d364f63a25f1c76309dca
2018-05-23 09:20:23 +00:00
chenxing
819663d134 Update the content about Import Format
Following by
https://git.openstack.org/cgit/openstack-dev/hacking/tree/HACKING.rst#n71

Change-Id: I2f32d773c12d484e8c0e435a78a3fe16d0eeae03
2018-05-22 15:36:19 +08:00
Brian Haley
cc52022447 Fix file mode on network-topology.rst
doc/source/contributor/specs/network-topology.rst was
executable, change mode to 0644.

Change-Id: I7e9c8a86ee8563f47da3f59c189b5bd5f3846344
2017-11-21 10:02:46 -05:00
Lin Yang
5b034ef653 Add python-rsdclient into plugin list
Intel RSD is new architecture that disaggregates compute, storage,
and network resources, and provide the ability to dynamically compose
resources based on workload-specific demands [1]. The python-rsdclient
project provide specific RSD plugin to allow user to invoke RSD API
through OpenStackClient. So Added it into existing plugin list.

[1] https://www.intel.com/content/www/us/en/architecture-and-technology/rack-scale-design-overview.html

Change-Id: Ic49efddfb003c89ece6d782905b27fb46402b3ab
2017-10-27 16:00:22 -07:00
Dean Troyer
676159555f Native DevStack jobs
Convert legacy DevStack jobs to native Zuul v3 form, plus some
test-job-related docs updates.

Change-Id: Ia8c08be81605da885b9eee799fc58129305dfc41
2017-10-24 17:35:55 -05:00
Hongbin Lu
e785570406 Add python-zunclient plugin
This patch adds the "appcontainer" commands to the docs and sets
up the document generation for the python-zunclient plugin

Change-Id: I58bd208e98bd059d9df03ee71dcb83779044f83a
2017-09-15 18:24:12 -04:00
yang wang
bd079e5066 Replace guildelines with guidelines
Change-Id: I9c4f15d320e2c506c16634a5a0e2fc324101189a
2017-08-04 19:06:10 +08:00
Hangdong Zhang
37998ad1c2 Update the documentation link for doc migration
Change-Id: I7833e40d66abe233af5a211bcefadc141fe8e54b
2017-07-24 11:33:07 +08:00
Michael Johnson
2bd124731a Add python-octaviaclient plugin
This patch adds the "loadbalancer" commands to the docs and sets
up the document generation for the python-octaviaclient plugin.

Depends-On: Ib123383c5f6904b4b00831e8cc7aaa180bd4a506
Change-Id: I48939cc3653cd379a328e0a0973d075019d22b00
2017-06-29 17:21:11 +00:00
Doug Hellmann
e7807bc0ed move auto-generated api docs into contributor tree
Change-Id: I2e75d3014bd2252af8c01566c0ec6787608e3996
Depends-On: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-23 11:57:31 +02:00
Doug Hellmann
9599ffe65d reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification.

Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.

Add a few toctrees and index pages for the new directories.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-23 11:54:32 +02:00