summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* | Merge "Fixe example code in Using Sessions page"Jenkins2015-05-281-2/+3
|\ \ | |/ |/|
| * Fixe example code in Using Sessions pageDhritiShikhar2015-05-271-2/+3
| | | | | | | | | | | | | | | | | | | | * Changes the auth_url to use /v3 * Adds the user_domain_id argument Co-Authored-By: Rodrigo Duarte Sousa <rodrigods@lsd.ufcg.edu.br> Closes-bug: 1428309 Change-Id: I8471d9fbbd4d14cbb60395f90e8e61b9ed9f7d3b
* | Removes temporary fix for doc generationDavid Stanek2015-05-073-58/+0
|/ | | | | | | | | A temporary fix was added to get around a bug in how pbr handles its autodoc_tree_index_modules setting. Since this bug is fixed we no longer need the work around. Change-Id: Id8274ef5c244bf50a34702ed9b4e50d3b82d8028 Closes-Bug: #1260495
* Merge "Don't autodoc the test suite"Jenkins2015-04-021-1/+3
|\
| * Don't autodoc the test suiteJamie Lennox2015-03-091-1/+3
| | | | | | | | | | | | | | | | Don't build API documentation for the keystoneclient tests. These are not public functions, pollute the existing docs, and extend the time required to build docs. Change-Id: I1206a808272d19b342d26f5117aedafb476d0994
* | Crosslink to other sites that are owned by KeystoneDave Chen2015-03-141-0/+9
|/ | | | | | | | | | Add links to identity service and keystone middleware to the landing page. This indicates to the user that the three projects are related. Change-Id: I37bb4cd866524bad69f90c53e6a58d58202fc263 Co-Authored-By: Steve Martinelli <stevemar@ca.ibm.com> Partial-Bug: #1428321
* Merge "Workflow documentation is now in infra-manual"Jenkins2015-02-101-1/+1
|\
| * Workflow documentation is now in infra-manualJeremy Stanley2015-02-051-1/+1
| | | | | | | | | | | | | | Replace URLs for workflow documentation to appropriate parts of the OpenStack Project Infrastructure Manual. Change-Id: I5b4f7bc5268132b129fc56c919af00d7f9600c9f
* | Merge "Fix up types within API documentation"Jenkins2015-01-181-0/+6
|\ \
| * | Fix up types within API documentationJamie Lennox2014-12-161-0/+6
| |/ | | | | | | | | | | | | | | Correct the type signature of some API documentation. Add inter-sphinx mapping to documentation to provide links to external docs. Correct some phrases and errors. Change-Id: Id4a71a9901e5adc695afed656e3bc84e4e54e67a
* | Add generic auth plugin documentationJamie Lennox2015-01-141-0/+28
| | | | | | | | | | | | | | Add some documentation regarding the existence of generic plugins. Those that can be used against the v2 or v3 APIs. Change-Id: Ie52f0653e20cbc9338481f874aaefa4cdee97116
* | Merge "Document the auth plugins that are loadable by name"Jenkins2014-12-311-0/+16
|\ \
| * | Document the auth plugins that are loadable by nameJamie Lennox2014-12-171-0/+16
| |/ | | | | | | | | | | | | | | | | | | | | These are the plugins that will be available for use by auth_token middleware and other services as they adopt sessions. There needs to be a good way to document the config parameters that each plugin exposes, because these are not necessarily the same as what are available via __init__. Change-Id: I4ad8ea89381be7571c8a30a6fcd9162c259eb581
* | Merge "Document session usage first"Jenkins2014-12-161-24/+30
|\ \ | |/ |/|
| * Document session usage firstBrant Knudson2014-10-121-24/+30
| | | | | | | | | | | | | | Since we'd prefer developers to use the session method when constructing the Client instance, document it first. Change-Id: I8998a9962fd541bafae32b3443d7d4767da74257
* | Merge "Rename the client API docs"Jenkins2014-12-022-6/+6
|\ \
| * | Rename the client API docsBrant Knudson2014-10-122-7/+7
| |/ | | | | | | | | | | | | | | | | | | Since developers want to use the APIs, the docs should be more enticing and say that it describes how to use the APIs. Also, called it "V3 Client API" since this reads better than "Client V3 API" and it matches the order in the module path. Change-Id: I79dd6f6891bf48b477b35157256a0219426d171c
* | Merge "Warn that keystone CLI is pending deprecation"Jenkins2014-12-021-3/+11
|\ \
| * | Warn that keystone CLI is pending deprecationBrant Knudson2014-10-121-3/+11
| |/ | | | | | | | | | | | | | | | | The keystone CLI is pending deprecation so warn about it in the developer docs. DocImpact Change-Id: Ibca9d4cd8d31a62ee1ec7f24671c8f0f01ca9f7f
* | Merge "Remove middleware architecture doc"Jenkins2014-12-022-429/+0
|\ \
| * | Remove middleware architecture docBrant Knudson2014-11-192-429/+0
| | | | | | | | | | | | | | | | | | | | | | | | The auth_token middleware was moved to the keystonemiddleware repo and the middleware architecture doc was copied there. The copy in the client repo can be removed. Change-Id: Ic7b7f970a08746dd4f5d61dd5144c1dae168ad6d
* | | Merge "Correct typos in man page"Jenkins2014-11-241-2/+2
|\ \ \ | |/ / |/| |
| * | Correct typos in man pageBrant Knudson2014-10-151-2/+2
| |/ | | | | | | | | | | A couple of typos in the keystone man page are corrected. Change-Id: I5931c1f128c5199c87317740abe1ee76b2c18489
* | Merge "Reorder index links"Jenkins2014-11-181-4/+2
|\ \
| * | Reorder index linksBrant Knudson2014-10-101-4/+2
| |/ | | | | | | | | | | | | The V3 Client link should come before the V2 Client link if that's what we want developers to use. Change-Id: I34a232d21862999a6f1a7acf5382ff752a7e3590
* | Merge "Correct typos in using-sessions"Jenkins2014-10-272-6/+6
|\ \
| * | Correct typos in using-sessionsBrant Knudson2014-10-122-6/+6
| |/ | | | | | | | | | | Fixed typos in using-sessions. Change-Id: Id931bfdb8eb8bf214ca538673e727c6bf1e06280
* | Doc cleanup, make concepts linksBrant Knudson2014-10-121-11/+12
|/ | | | | | | Rather than just mention the concepts, make each reference a link to the concept's representation in the API. Change-Id: I4dadca0395784eb43e5bbb3cfd65c56c8f56ed38
* Stop using intersphinxAndreas Jaeger2014-09-131-5/+0
| | | | | | | | | | | | | | Remove intersphinx from the docs build as it triggers network calls that occasionally fail, and we don't really use intersphinx (links other sphinx documents out on the internet) This also removes the requirement for internet access during docs build. This can cause docs jobs to fail if the project errors out on warnings. Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb Related-Bug: #1368910
* Remove intersphinx mappingsJamie Lennox2014-08-071-4/+1
| | | | | | | | | | | | None of our documentation references any external sphinx documents so we don't need the intersphinx mappings. This started as a rename from the old glance.openstack.org site to the newer docs.openstack.org/developer/glance however they may as well be removed if not used. Closes-Bug: #1353817 Change-Id: I638c4eeab7d01ec2f26a0d9d532f0006f4f75e72
* Merge "Add docs for how to create an OAuth auth instance"Jenkins2014-08-051-0/+20
|\
| * Add docs for how to create an OAuth auth instanceSteve Martinelli2014-08-041-0/+20
| | | | | | | | | | | | | | | | Similar to the other authentication methods that were documented, like password and token, this patch will add a brief description on how to authenticate with the oauth1 plugin. Change-Id: I1b7cceb116d337be71576139601f34ca17563a50
* | Merge "Add an example of using v3 client with sessions"Jenkins2014-07-301-0/+20
|\ \
| * | Add an example of using v3 client with sessionsSteve Martinelli2014-07-241-0/+20
| |/ | | | | | | | | | | | | | | | | Added a bit more information to the 'using-api-v3' section, about using sessions instead of passing in arguments. This overlaps with what is documented in 'using-sessions' but I think it's still handy as most folks will likely go here first. Change-Id: I352bda49e01362d3a5da9a79ceb34748552ef9ec
* | Use oslosphinx to generate doc themeSteve Martinelli2014-07-2412-1230/+5
|/ | | | | | | Since oslosphinx is out, let's use it instead of hosting our own themes and static files. Change-Id: I5b507d35c90d0c0411d7751935b0e53328ca9311
* Document authentication pluginsJamie Lennox2014-07-022-0/+174
| | | | | | | | Explain the plugins that are provided and some information on how to write new ones. This will obviously need to be expanded as more features are added. Change-Id: Ie67e93f2ed994c3702ac66e388cf216609dd44ff
* Correcting using-api-v2.rstMichael McCune2014-06-261-1/+1
| | | | | | | | Changes * removed extraneous word from Introduction section Closes-Bug: #1334915 Change-Id: I201ddb70a4d91e0d615e322abc43848993dee573
* Merge "Session Documentation"Jenkins2014-06-142-0/+199
|\
| * Session DocumentationJamie Lennox2014-06-132-0/+199
| | | | | | | | | | | | | | | | | | Include some client documentation for how to work with a Session object. This is generally high level with this expectation that a developer could take the concepts found here and determine more from the module documentation. Change-Id: I5e44c1029ce160cb2798cfb8a535aa9f3311799a
* | Link to docstrings in using-api-v3Brant Knudson2014-06-121-8/+10
|/ | | | | | | | The references to classes and modules were just the names and didn't link to the docstrings for the class or module. With this change, names are now links to the class or module. Change-Id: I9c7c03e8221ca71c7fddc0682abadc7a78d371db
* Add role assignments as concept in Client API V3 docsRodrigo Duarte Sousa2014-06-021-0/+1
| | | | | Change-Id: Ia04e51d98b5f00a28d94c24ed7665fcead3f6507 Closes-Bug: #1325739
* Update docs for auth_token middleware config optionsBrant Knudson2014-04-131-19/+119
| | | | | | | The documentation for the auth_token middleware config options was out of date. Change-Id: I8d03d77c58c714375e1e5174962991aa3adc61af
* Merge "Reference docstring for auth_token fields"Jenkins2014-03-311-33/+4
|\
| * Reference docstring for auth_token fieldsBrant Knudson2014-03-191-33/+4
| | | | | | | | | | | | | | | | | | The documented variables that the auth_token middleware sets for the request was out of date with the code. Rather than maintain the documentation for the fields in 2 places we'll now link to the auth_token module docs. Change-Id: Id4ca1843f749c1ed0b515c8860764add3ec4a3da
* | Remove releases.rst from keystone docsSteve Martinelli2014-03-252-34/+0
|/ | | | | | | | | The most recent update to releases.rst was made back in 2012, but it's references in the docs page. It is providing false (or at least, inaccurate) information. Suggest removing it since the server side doesn't have a release related file either. Change-Id: If2a71b55117c450afdade3cad697eba5a626263f
* Docs link to middlewarearchitectureBrant Knudson2014-03-181-0/+2
| | | | | | | There was no link to the middleware architecture from the main page so nobody would know that it's there. This adds the link. Change-Id: I2cd7a458b48d2c2889e4305e01bc013796a67c6e
* Fix doc build errorsBrant Knudson2014-03-131-1/+1
| | | | | | | | There were some parts that had invalid RST in their docstrings which caused warnings and errors to be generated. Related-Bug: #1278662 Change-Id: Ibb53e6f49b5fa100fa6ecfe47331f9a70729d03b
* Generate module docsBrant Knudson2014-03-133-1/+58
| | | | | | | | | The module docs were not being generated. Co-Authored-By: David Stanek <dstanek@dstanek.com> Change-Id: I26e1d9a3d407474eb6b016f3ada4c495b5043460 Closes-Bug: #1278662
* Merge "Remove reference to non-existent shell doc"Jenkins2014-03-091-2/+2
|\
| * Remove reference to non-existent shell docBrant Knudson2014-03-091-2/+2
| | | | | | | | | | | | | | There's no "shell.rst" document, so the index shouldn't reference it. Change-Id: I0d02b32349cfb6592b432700b4e04fda7fecbba8
View Lorry Controller Status