summaryrefslogtreecommitdiff
path: root/doc/source/contributor
Commit message (Collapse)AuthorAgeFilesLines
* Merge "Add plugin doc page for cyborg"Zuul2022-12-201-0/+1
|\
| * Add plugin doc page for cyborgShogo Saito2022-12-201-0/+1
| | | | | | | | | | | | This patch add cyborg (accelerator) doc page. Change-Id: I0f3e5419ce522e620be805c0fcd829c8dfb2e317
* | Merge "docs: Fix typos"Zuul2022-12-201-2/+2
|\ \ | |/ |/|
| * docs: Fix typosStephen Finucane2022-12-051-2/+2
| | | | | | | | | | Change-Id: I902e8b35d4423f91dd8cdeecbcc7e60af877da75 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | docs: Document how we manage API versionsStephen Finucane2022-11-301-1/+133
|/ | | | | | | | Document that microversion auto-negotiation is acceptable. Heck, it's downright desirable. Change-Id: Ib256e064d1e8b6dc8273e482276dce243f9991cb Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* docs: Describe common actions found in OSCStephen Finucane2022-11-301-23/+240
| | | | | | | | | | | 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>
* docs: Typo fixStephen Finucane2022-11-251-1/+1
| | | | | Change-Id: I2d55747b1226207946f80f04b80b4685e3eea3f9 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* docs: Small cleanup of human interface guideStephen Finucane2022-11-241-37/+43
| | | | | | | Before we add more content. Change-Id: I6cf28bdd217326db991466a21221b685124d4b99 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Fix that the path of functional testryanKor2021-09-251-1/+1
| | | | | | | | | | | | | 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
* Add pre-commitStephen Finucane2021-03-111-13/+40
| | | | | | | | | 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>
* Update the file paths mentioned in README.rstTakashi Kajinami2021-03-151-7/+7
| | | | | | | This change fixes the outdated file paths, which were renamed by commit 9599ffe65d9dcd4b3aa780d346eccd1e760890bf . Change-Id: I9ec4c49711a2fde24f5527086e495c86af9ef1ce
* Remove retired Karbor supportStephen Finucane2021-01-081-1/+0
| | | | | | | | | | 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>
* Remove retired Searchlight supportGhanshyam Mann2020-12-081-1/+0
| | | | | | | | | | | | 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
* Remove references to Python 2.7Stephen Finucane2020-11-051-8/+7
| | | | | | | We don't support it anymore. This is just noise now. Change-Id: I3640e7d8e520db69f83f95e9c7759279f7c15008 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Remove references to setuptoolsStephen Finucane2020-10-222-4/+3
| | | | | | | | | | 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>
* Remove usage of sixsongwenping2020-10-071-1/+0
| | | | | | | | | | | 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
* Update developing.rstlikui2020-09-081-1/+1
| | | | | | Use unittest.mock instead of mock Change-Id: Ib573e9d217b4f18ef4e7ba3ab581164be423cb26
* Remove congressAndreas Jaeger2020-06-041-1/+0
| | | | | | | | | 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
* Merge "Update the content about Import Format"Zuul2020-03-201-9/+12
|\
| * Update the content about Import Formatchenxing2018-05-221-9/+12
| | | | | | | | | | | | | | Following by https://git.openstack.org/cgit/openstack-dev/hacking/tree/HACKING.rst#n71 Change-Id: I2f32d773c12d484e8c0e435a78a3fe16d0eeae03
* | Remove mention of meetings from docsKendall Nelson2020-01-281-6/+5
| | | | | | | | | | | | | | | | 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
* | Add placement to known pluginsEric Fried2019-10-211-0/+1
| | | | | | | | | | | | | | Add the osc-placement project (osc plugin for the placement service) to the list of known plugins. Change-Id: I77b614b38ecf872d0d93473b834994913930b76f
* | Remove python-ceilometerclientWitold Bedyk2018-09-281-1/+0
| | | | | | | | | | | | | | | | Project is retired [1]. [1] https://github.com/openstack/python-ceilometerclient Change-Id: Idc3a340c99c9fd79d80c90e45fd9a1c44c205218
* | Add monascaclient to `not plugins` listWitold Bedyk2018-09-281-0/+1
| | | | | | | | Change-Id: I377a018a4e3c7b6fa44ce9323d1ee2edbd0e4728
* | Add cliff project linkzhang.lei2018-05-231-1/+1
|/ | | | Change-Id: I6a964781667aa92f4b8d364f63a25f1c76309dca
* Fix file mode on network-topology.rstBrian Haley2017-11-211-0/+0
| | | | | | | doc/source/contributor/specs/network-topology.rst was executable, change mode to 0644. Change-Id: I7e9c8a86ee8563f47da3f59c189b5bd5f3846344
* Add python-rsdclient into plugin listLin Yang2017-10-271-0/+1
| | | | | | | | | | | | 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
* Native DevStack jobsDean Troyer2017-10-241-10/+7
| | | | | | | Convert legacy DevStack jobs to native Zuul v3 form, plus some test-job-related docs updates. Change-Id: Ia8c08be81605da885b9eee799fc58129305dfc41
* Add python-zunclient pluginHongbin Lu2017-09-151-0/+1
| | | | | | | This patch adds the "appcontainer" commands to the docs and sets up the document generation for the python-zunclient plugin Change-Id: I58bd208e98bd059d9df03ee71dcb83779044f83a
* Replace guildelines with guidelinesyang wang2017-08-041-1/+1
| | | | Change-Id: I9c4f15d320e2c506c16634a5a0e2fc324101189a
* Update the documentation link for doc migrationHangdong Zhang2017-07-243-3/+3
| | | | Change-Id: I7833e40d66abe233af5a211bcefadc141fe8e54b
* Add python-octaviaclient pluginMichael Johnson2017-06-291-0/+1
| | | | | | | | 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
* move auto-generated api docs into contributor treeDoug Hellmann2017-06-231-0/+1
| | | | | | Change-Id: I2e75d3014bd2252af8c01566c0ec6787608e3996 Depends-On: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* reorganize existing documentation according to the new standard layoutDoug Hellmann2017-06-2312-0/+1759
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>