summaryrefslogtreecommitdiff
path: root/doc/source/index.rst
Commit message (Collapse)AuthorAgeFilesLines
* Update release table for Train and 4.0.0Dean Troyer2019-09-101-2/+1
| | | | | | | Also clean up some docs and release notes. Change-Id: I73feec747ca1bd12be5e5700c9ca608ed3a8b2c2 Signed-off-by: Dean Troyer <dtroyer@gmail.com>
* Fix link to new opendev repoAdam Spiers2019-05-011-1/+1
| | | | | | The switch to an opendev URL wasn't quite right, resulting in a 404. Change-Id: I652f093384a584a56290a9b080913392873efd9f
* Followup opendev cleanup and test jobsDean Troyer2019-04-191-1/+1
| | | | | | | * upper-constraints references need s/plain/raw/ Change-Id: I04368dc42f1a62a048ac9d11497747ef6f600515 Signed-off-by: Dean Troyer <dtroyer@gmail.com>
* Change bug url to a correct onetianhui2018-06-271-1/+1
| | | | | | | The url for the python-openstackclient bugs is deprecated and needs to change it to a correct one. Change-Id: I3762faf27fdb647dbff2e47b19d238108ef1975f
* Trivial: Update pypi url to new urlTovin Seven2018-04-201-1/+1
| | | | | | | | | Pypi url changed from [1] to [2] [1] https://pypi.python.org/pypi/<package> [2] https://pypi.org/project/<package> Change-Id: I61f3d53737616dbbd6df725823b5335a57045dba
* move auto-generated api docs into contributor treeDoug Hellmann2017-06-231-1/+0
| | | | | | 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-231-28/+9
| | | | | | | | | | | | | 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>
* doc: Correct Sphinx warningsStephen Finucane2017-03-281-1/+1
| | | | | | | | | | | | | | | - Fix option-describe typos - Correct option and envvar markup, for commands that are using the reference form instead of the definition form or are marking up option arguments as options - Avoid duplicate commands - Fix some invalid docstrings - Fix some invalid indentation - Disable the murano plugin, which has invalid docs - Correct issues with- and track the network-topology spec - Include API modules in docs Change-Id: I3d5ed5e872540fe13f3e4bd5e9335829dc9a5226
* docs: Don't include ChangeLogStephen Finucane2017-03-201-1/+0
| | | | | | | | The ChangeLog is built using commit message summary lines. Unfortunately some of these contain invalid rST markup. There's no way to retroactively fix this, so simply stop including the doc. Change-Id: I6600c1baf142fe4c776f1ae170faa3f6a87b330c
* minor tweaks to mapping tableSteve Martinelli2017-02-221-0/+4
| | | | | | | | - no need to prefix it with OSC - since it's a page with a lot of content, make it show sub headings Change-Id: I1aab4f71def53f1a11a8a0e0f6b7748233ff02c7
* add swift and nova to osc mappingSteve Martinelli2017-02-211-0/+1
| | | | Change-Id: If3ab811868aaf8c9391a2190ff0af63b0e0ea559
* Add doc for logger usageTang Chen2016-06-161-0/+1
| | | | | | | | This patch adds a doc to record rules of usage of loggers in OSC. Change-Id: I27a09f9abb523393031560e2310bfdd1af0b8922 Implements: blueprint log-usage
* include old release notes in renoRui Chen2016-05-311-1/+1
| | | | | | | | | Currently OSC release notes are in the OpenStack releasenote site. There is a collection of old non-reno release notes in our docs folder. Move the non-reno release notes to the reno directionary. Change-Id: Ie51fd1e1115d606e5d2739014d3720eedc8dc225
* Devref: Command BetaRichard Theis2016-04-211-0/+1
| | | | | | The devref proposes OSC support for beta commands. Change-Id: I538a38be33734faf6eb69a3cb50946b2396b0c57
* Clean up for next releaseDean Troyer2016-04-181-1/+1
| | | | | | | * Release notes * Docs Table of Contents Change-Id: I4bef26ed348923671a2b50f90606661d519b40e3
* Add doc describing how to handle API errorsDean Troyer2016-03-111-0/+1
| | | | | | | | Include the following scenarios: * general external errors * a command with multiple API calls Change-Id: Ie5c4b775e11898bacf2156a34457f5397fd2c891
* Merge "Doc: Add optional command specs process"Jenkins2016-02-041-0/+1
|\
| * Doc: Add optional command specs processRichard Theis2015-12-141-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | The developer documentation has been updated to include an optional command specs process. This process may be used to work out the specifications for new commands, objects and actions before their implementation. This new process could assist in the implementation of additional neutron support in OSC. Change-Id: I62f7472435a9caacee0d1b4c8d35417c123b5a44
* | Merge "Use Block Storage instead of Volume"Jenkins2016-01-041-2/+3
|\ \ | |/ |/|
| * Use Block Storage instead of VolumeXi Yang2015-11-271-2/+3
| | | | | | | | | | | | | | Volume is better to be replaced by Block Storage in the doc. Change-Id: I736669ee01c7385b6e701cb20f4334eff1c49286
* | autodocument commands from plugins using stevedore.sphinxextSteve Martinelli2015-12-011-0/+1
| | | | | | | | | | | | | | | | conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
* | Add a changelog to see all changes into tagged releasesSteve Martinelli2015-11-301-1/+9
| | | | | | | | | | | | | | in addition to release notes, it'll be nice to also see the changelog that happened between releases. Change-Id: I4548be22c377ec12f0398a248391384126506715
* | Merge "Add command wrapper doc"Jenkins2015-11-301-0/+1
|\ \ | |/ |/|
| * Add command wrapper docDean Troyer2015-11-201-0/+1
| | | | | | | | | | | | | | | | This is a follow-up to I6c750730963615895f5d9953487d2d5a905885a8 that removed a command deprecation warning wrapper. This documents the technique for later use. Change-Id: Ieaa1e6b7eed4e5b037b4bfb6cf488e1290fc69f7
* | Change 'Object Store' to 'Object Storage'Xi Yang2015-11-261-1/+1
|/ | | | | | | Because the official documents uses 'Object Storage', so change it in this project. Change-Id: I87c0996b48c452b3ff619b8214676ae377e6d0af
* Add Command Options guideline docDean Troyer2015-10-211-0/+1
| | | | | | | Add a developer guideline for command options to define the options used across multiple commands and make them behave consistently. Change-Id: I1dbbafe8061e10b271cd55cac056731508c52204
* Add developer documentationSteve Martinelli2015-08-081-1/+9
| | | | | | | | | OSC was missing developer docs, these are critically helpful for new developers. Add sections related to running tests (tox, functional and with the debugger), and generating docs locally. implements bp: developer-documentation Change-Id: I428d89c3e5fc335864bc4f7843506043ec332fe5
* Add a reference to the IRC channelsJens Rosenboom2015-06-031-0/+2
| | | | | | | | As the name of the associated IRC channel for this project is not completely obvious, add a reference to the doc index page so that it may be found easier. Change-Id: I6cb6e2571bff73db6d983cd96fe6d03319d6577c
* Add a doc that dictates backwards incompatible changesSteve Martinelli2015-04-231-0/+1
| | | | | | | | start tracking any changes in a standard format, so users may have a heads up about any impacts. Change-Id: Ibc06926a53592e927d11440362cd3598e0d4b2bf Closes-Bug: 1406470
* Begin documenting --os-cloudDean Troyer2015-04-181-0/+1
| | | | Change-Id: Id2e98ac5601840f6d380cabcd578f1a6d6d9b245
* Create 1.0.2 release notesSteve Martinelli2015-01-191-1/+1
| | | | | | | Also move the release notes to the bottom of the ToC, no need for it to be at the top, that's prime real estate. Change-Id: Ib3094a390a7214b320d02f77229f368aa4432c4e
* Merge "Copy HIG from wiki"Jenkins2015-01-151-0/+1
|\
| * Copy HIG from wikiDean Troyer2015-01-131-0/+1
| | | | | | | | | | | | | | | | This is a basic port of the Human Interface Guide from the OpenStack wiki to our docs. Content changes for updating, etc, will follow in a separate review. Change-Id: Id031cd6a27e045b249e16d00e41be24c55fb3c29
* | Copy wiki content to index pageDean Troyer2015-01-131-8/+23
|/ | | | | | | Copy the content from the main wiki page that is not covered elsewhere in these docs to the index page. Change-Id: I94b68b7a0117d08fc8aba961c6de728118ef794e
* Merge "Workflow documentation is now in infra-manual"Jenkins2014-12-061-1/+1
|\
| * Workflow documentation is now in infra-manualJeremy Stanley2014-12-051-1/+1
| | | | | | | | | | | | | | Replace URLs for workflow documentation to appropriate parts of the OpenStack Project Infrastructure Manual. Change-Id: Id09c9bdf8804c1ed90e49606e76ffbff1d96a7c2
* | Add documentation of interactive modeDean Troyer2014-12-041-0/+1
|/ | | | | | This is a light description with some examples. Change-Id: Iff9ad904a150f2bb7673bd4106cf26bcefec08b9
* Merge "Enhance the theming for modules page"Jenkins2014-12-011-2/+2
|\
| * Enhance the theming for modules pageSteve Martinelli2014-11-181-2/+2
| | | | | | | | | | | | Also fixes a few small docstring syntax errors Change-Id: I85eb968e32c1191cf5d60d02deff2ab7f3291074
* | Begin copying wiki command list hereDean Troyer2014-11-191-0/+1
| | | | | | | | | | | | | | | | | | | | * Sort by command objects * Drop the comparison to the project CLIs * Minor updates to command help to match docs Initially include the cross-API commands to establish the structure and format. Change-Id: I77a7b3c89e088b66aa62941e29ce0b65b532285b
* | Add authentication description docDean Troyer2014-11-171-0/+1
|/ | | | | | | | This is represents the current operation Closes-Bug: #1337422 Change-Id: I8092e7723b563647e13b6e2f0b7901a16572b6c7
* Acknowlege git.o.o as OpenStack's git serverAnita Kuno2014-09-181-5/+5
| | | | | | | OpenStack's cannonical git server is at git.o.o this patch updates the index.rst to reflect that. Change-Id: I54eeea7fab2e0f64ca9f23f7c328e2ff19721a41
* Update docs and release notes for 0.4.1 releaseDean Troyer2014-09-081-3/+2
| | | | | Closes-Bug: 1365505 Change-Id: I027d263ba9980715454b034a37733c5ff23fd169
* Update docs and release notes for 0.4.0Dean Troyer2014-06-201-3/+5
| | | | Change-Id: Iad6cfe5dee63adb9e60a0ea9811217b3175eb99c
* Update docs for plugins and release notesDean Troyer2013-12-051-0/+1
| | | | | | | | * Fill out the existing command and man page * Add a plugins page. * Begin the release notes for 0.3.0 Change-Id: I4527fed28a10a9d79fc8f6c1d925a4bf0d0a7a36
* Add release notes in docs0.2.1Dean Troyer2013-08-061-9/+1
| | | | Change-Id: I49dc936a37848745ce3412e810b98348558d1157
* Prep for 0.2 release (0.2.rc1)Dean Troyer2013-08-011-5/+21
| | | | | | | | * rename HACKING to HACKING.rst and refer to the common OpenStack HACKING file * add the barest of pointers to the wiki, etc. to the source docs * add a bare-bones man page Change-Id: I80e5b972af645f14ef17ae87f182ab09cb08dabe
* Fixed a typo in the rst docs.Lorin Hochstein2012-06-261-1/+1
| | | | Change-Id: Ie3484f8fe0a63ff5a6815f3ec440adf7dc5d9482
* Update Contributing blurb in the docs.Clark Boylan2012-06-221-3/+6
| | | | | | | | Contributing blurb previously mentioned social coding and Github. The OpenStack contribution workflow is slightly different. Provide details on Github, LP, and Gerrit. Change-Id: Ie5ecd25e5828de611561f37b3acbccc5cf3f0d04
* Move docs to doc.Clark Boylan2012-06-111-0/+32
To better facilitate the building and publishing of sphinx documentation by Jenkins we are moving all openstack projects with sphinx documentation to a common doc tree structure. Documentation goes in project/doc/source and build results go in project/doc/build. Change-Id: I925e687254bac9e06c2c520f4fc35a083e21c4ca
View Lorry Controller Status