Commit Graph

36 Commits

Author SHA1 Message Date
Samriddhi Jain 459f078d0c Reorganised keystone documentation structure
Divided the keystone docs into four categories, depending
upon the usage criteria: general information (which will
be common for all), developer documentation,
user documantation and operator documentation.

Change-Id: I2f5dd41acd9874739accc54c4f4fd69460b58334
2017-06-22 13:26:46 +05:30
Eric Brown 30d9095d28 Use https for docs.openstack.org references
The openstack.org pages now support https and our references to
the site should by default be one signed by the organization.

Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
2017-01-30 16:05:08 -08:00
Gage Hugo b9c8963d0a Fixed multiple warnings in tox -edocs
There are multiple tracebacks and warnings being thrown whenever
the keystone docs are built due to documents being moved/deleted as
well as formatting issues in a couple places.

This fixes a few of the warnings due to broken links and fixes a few
of the method docs.

Master: http://paste.openstack.org/show/591730/
This Patch: http://paste.openstack.org/show/591735/

Change-Id: I11cbbc7a10fa24dcbf67c76e3061a39a58529c06
Partial-Bug: #1602422
2016-12-07 16:26:53 -06:00
nonameentername f6ac0661bf Update documentation to remove keystone-all
keystone-all command was removed but no alternative for running
keystone in developer mode was added.  Update documentation with uwsgi
command and update keystone-all reference.

Change-Id: Ia949620de21c1b05127769c6da249b38d83cda9c
2016-05-10 17:06:49 -05:00
Eric Brown 8eacf0c98c Minor edits to the installation doc
* Removed referece to Ubuntu Precise. Mitaka packages are not
  available on Precise.
* Removed a false statement that apt-get would prompt the user for
  configuration options when installing the debian package.

Change-Id: Id588e99a4c17836156bb56b6c7322291f9f81af3
2016-02-25 22:30:32 -08:00
Brant Knudson c420c81fcf Correct docstrings
There were several warnings logged when docs were built due to
invalid rst and other issues.

Change-Id: I61289d05377b8e70afbcf8786d4159354aa67ed8
2016-02-01 21:35:15 -05:00
venkatamahesh d2bbffeea8 Fedora link is too old and so updated with newer version
Link for fedora install guide is too old (juno). So it is
updated with liberty version

Change-Id: Id2bf138eae832175fa563de939de858e0a3a070f
Closes-Bug: #1499841
2016-01-15 16:26:11 +00:00
Dolph Mathews e536522356 Use pip (and DevStack) instead of setuptools in docs
The docs instruct you to install pip, and then document the use of
setuptools, which pbr doesn't particularly support. But pip alone will
fail, so I added a note referencing devstack if you need help on that
step.

Change-Id: Iea07b5ffd9d5c6c8509a698db2728e0fde21d4d8
2015-12-16 16:52:53 +00:00
Brant Knudson a0c531031a Move development environment setup instructions to standard location
According to [1], every project should publish instructions for
setting up a development environment to
http://docs.openstack.org/developer/<PROJECT_NAME>/devref/development.environment.html

Keystone's development environment setup instructions are moved
there for consistency.

[1] https://wiki.openstack.org/wiki/Getting_The_Code#Hacking_on_your_laptop_and_running_unit_tests

Change-Id: I084fd0dd9fc4f4ec768649718d86a8ccac990dfd
2015-09-23 15:18:32 -05:00
Jeremy Stanley ccd49cf95d Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Also update some outdated/obsolete devstack-related URLs.

Change-Id: I84e3a62b0aec7cb62d10b8b41eac27b15326ab5c
2015-05-16 14:55:07 +00:00
liu-sheng 37f3a8ad54 Replace github reference by git.openstack.org and change a doc link
* Replace the github by openstack's official home git.openstack.org
* Also update the like of developer documentation of keystone

Change-Id: I60e8e914d9fa3be2cdfffe029e4c2432c07962e2
2015-05-07 10:08:10 +08:00
Steve Martinelli b7e847d737 Update install.rst for Fedora
Remove refernces to Fedora 17, and link back to the official
install guide, and our documented configureservices.rst.

Change-Id: I500ce50340ef41de1393ce700e3fd59e47489ce0
Closes-Bug: 1426704
2015-03-25 01:04:14 -04:00
Steve Martinelli a02d95c408 Add rst code-blocks to a bunch of missing examples
Several examples were either missing code-blocks entirely,
this patch added either bash or python, so the rendered HTML
is nicer.

Change-Id: Ia145dc78a871dc27cf0926ea1ef9cf9b6df564b7
2014-09-04 17:13:23 -04:00
Steve Martinelli 2fdb53d461 Capitalize all instances of Keystone in the docs
There were quite a few instances of `keystone` where `Keystone`
should have been used. Code examples were not changed, since that
would break things.

Change-Id: I533ad1b71cc3af1b70bb54cca0a820aaad3f62da
2014-09-04 12:29:01 -04:00
David Stanek f15471f5fd Corrects minor spelling mistakes
Change-Id: Ib603861ad19a525c112153ac3799f2cbe453d4f7
2014-06-24 13:50:31 +00:00
Steve Martinelli 5dbb794347 Fix spelling mistakes in docs
Noticed a bunch of minor spelling mistakes.

Change-Id: I8189dda5a78418820e6c56270089590ef87f1495
Closes-Bug: #1323361
2014-05-26 12:52:20 -04:00
Dolph Mathews 0516c3cbd6 install from source docs never actually install the keystone service
Change-Id: I4997f60f3c4746821e8cd8db76b1d54fe786ccfa
Closes-Bug: 1322735
2014-05-23 15:12:57 -05:00
Alex Gaynor 6caaddad85 Fixed some typos throughout the codebase
Change-Id: I66e421b1743f7b3e3e7ecd34e64f67b6e0a53f2c
2014-05-01 07:16:02 -07:00
Sean Winn 0331f8a58a Changed header from LLC to Foundation based on trademark policies
Fixes: Bug 1214176

Change-Id: Ie937081a53d377671b8b88f422642c8131002f88
2013-09-05 15:03:32 -05:00
Jenkins f1172aac7d Merge "Fix internal doc links (bug 1176211)" 2013-06-10 14:13:07 +00:00
Dolph Mathews 8933956f5c Fix internal doc links (bug 1176211)
Change-Id: Iab416c941c7db00d3fd725e1c0e12ed7fc193dd0
2013-06-07 15:33:41 -05:00
Dolph Mathews 87da367914 Missing contraction: Its -> It's (bug 1176213)
Change-Id: I9403289012eea3b78f9bf02154827554d9e07462
2013-06-07 15:05:15 -05:00
Jenkins c539b89272 Merge " Rename requires files to standard names." 2013-05-31 04:02:04 +00:00
Alan Pevec 64738924b8 separate paste-deploy configuration from parameters
PasteDeploy configuration contains class names which might change
between releases. Keeping it separate from user-configurable
parameters allows deployers to move paste-deploy ini file out of
configuration directory to a place where it can be safely overwritten
on updates e.g. under /usr/share/

DocImpact

Change-Id: I9292ca6226c8430b93565dedd45cc842742a23e2
2013-05-26 17:36:08 +02:00
Carlos D. Garza 2bc22ef6f7 Rename requires files to standard names.
Rename tools/pip-requires to requirements.txt and tools/test-requires
    to test-requirements.txt. These are standard files, and tools in the
    general world are growing intelligence about them.

Fixes: bug #1179008
Change-Id: I1a19f0c73ab48987e2ff0dade1a57a68b65f0a22
2013-05-24 17:55:05 -05:00
Joe Savak 1121b8da63 bug 1159888 broken links in rst doc
Change-Id: Iad8e63ab57c927032e4bafab79c1f22cb485173f
2013-03-26 13:37:42 +00:00
Joe Gordon ac6ee6901c Fix spelling mistakes
git ls-files | misspellings -f -
Source: https://github.com/lyda/misspell-check

Change-Id: Icbd2412aa65bc8135e5dcd83ee69e94f5a42f7a2
2013-02-12 11:17:31 -08:00
Joe Heck 00a2392785 Installing keystone docs
fixes bug 954217

Change-Id: Iba79d2d5bae836037d5b0e10169d9bbdba8603dc
2012-03-14 19:17:54 -07:00
Dolph Mathews 043715e95c Moving contributor docs into rst (bug #843056)
- Added "Setting up a development environment" doc
  - Removed related info from pip-requires & project README
- Added "Testing" doc
  - Removed related info from project README
- Also removed contributor doc build info from project README (bug #843056)
- Updated version string to '2012.1-dev'

Change-Id: I58c79acd91dc391e3fa85911d09f74ad54d9d444
2011-10-28 09:26:19 -05:00
Joe Heck c18c093573 updates to keystone documentation - install & conf
bug 843056
blueprint keystone-documentation

Change-Id: I34004c8b75bc2c593d959af155b2749c09c2276d
2011-10-25 10:03:31 -07:00
Joe Heck 20c2adb9ac updating keystone developer documentation
updating docstrings to remove errors in automodule generation
updating setup.py to generate source documentation
blueprint keystone-documentation
bug 843056

Change-Id: Ie8dfedc89c1a6d9ffa5106d29dd19837b02746ce
2011-10-21 16:39:46 -07:00
Joe Heck 9f6336ceb0 updating docs for Mac source install, no docs for mac package install relevant
Change-Id: Ife997e0f7deb7c021b692d5abab641191c332a5c
2011-09-29 16:47:20 -07:00
Anne Gentle 6bb2ba8ddb Adds list of dependencies to dev install
Change-Id: I96450d614209ec9e7f1c51f72805d5d7495728ff
2011-09-28 13:21:32 -05:00
Joe Savak aa31899318 Adding curl documentation and additional installation doc. Also
updated man documentation for keystone-manage

Change-Id: I9aef365b6fdac2c10cd3c7f0864c8f375a878136
2011-08-11 14:02:19 -05:00
Joe Savak cb92ef7dba Committer: Joe Savak <joe3963@joe3963-VirtualBox.(none)>
On branch JS-KEYSTONE-DOC
 Changes to be committed:

	modified:   installing.rst

Updated install instructions for Debian/Ubuntu to pull code from git repo instead of using bzr

Change-Id: I645759b5d675f0717bc3fc1f910af8236dd8cdff
2011-08-09 11:00:34 -05:00
Jay Pipes 9981a1faa1 Adds Sphinx build ability and RST documentation. 2011-06-14 15:19:49 -04:00