diff options
| author | Devananda van der Veen <devananda.vdv@gmail.com> | 2016-08-17 15:20:50 -0700 |
|---|---|---|
| committer | Jay Faulkner <jay@jvf.cc> | 2016-08-23 12:49:04 -0700 |
| commit | d0e49e1b418e5d590c609a75be61b7507091a6bd (patch) | |
| tree | 9a39e1d947d889a80e2b2a07dbdc1c8ef6f16372 /README.rst | |
| parent | 77875d6acaea7134b031e3d307c57509e0d1033a (diff) | |
| download | ironic-d0e49e1b418e5d590c609a75be61b7507091a6bd.tar.gz | |
Documentation update
This patch contains several changes to the documentation which
were brought about by, initially, removing the webapi/v1 page and
replacing it with a link to the /api-ref/ page.
As I did that, I saw that our front page (index.html) needed to
be updated as well, and decided that the front page needed to
actually be completely rerwitten -- while preserving all the links.
Some of the TOC links from the front page were malformed because
subpages included more than one H1 heading, so I had to make small
changes in the api-audit-support and code-contribution-guide and
dev-quickstart pages, in order for the front page to render properly.
As I corrected the headings on dev-quickstart, I realized the page
was not comprehensively organized, and so decided to reorganize the
sections and make it easier to navigate.
Here is a bullet-point summary of this change:
* Major changes to content and organization of index page
* Moved the version history from webapi/v1 to dev/webapi-version-history
* Added API conceptual guide at dev/webapi
* Replaced webapi/v1 with a link to dev/webapi, in case anyone
bookmarked it
* Removed doc references to webapi/v1
* Merged the pages dev/contributing and dev/code-contribution-guide
* Removed duplicate H1 headers in deploy/api-audit-support
* Reorganized and renamed section headers in dev/dev-quickstart,
and made some substantive corrections and changes as well
* Updated wording at the top of the index and deploy/user-guide pages.
Change-Id: Ib418e1d4fdfab4f0e15560270f39922e33df3f12
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/README.rst b/README.rst index 2b31fb0f8..7f2f32d7c 100644 --- a/README.rst +++ b/README.rst @@ -26,4 +26,4 @@ on Launchpad: http://launchpad.net/ironic For information on how to contribute to ironic, see -http://docs.openstack.org/infra/manual/developers.html +http://docs.openstack.org/developer/ironic/dev/code-contribution-guide.html |