Commit Graph

27 Commits (master)

Author SHA1 Message Date
Jay Faulkner 65b8895e8a Update docs: Ironic uses launchpad now
Ironic switched to launchpad. Ensure our docs point contributors to the
correct location.

Change-Id: Ifa75c75741dd4a584bc2cb972eb4726c4c48d064
2023-05-17 15:42:41 -07:00
liushuobj 3747e14189 Add ironic-specs link to readme.rst
Change-Id: I80ba4c5575feae9b03bb8fa30eba68312d4c9ce2
2019-08-30 17:16:09 +08:00
Andreas Jaeger daddf516bf Update api-ref location
The api documentation is now published on instead
of Update all links that are changed to the
new location.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:

Change-Id: I30a51394d396cc89f647b4170d6a2e6b0b993dcb
2019-07-22 19:19:38 +02:00
ZhongShengping a280696a03 Replace URLs with URLs
Thorough replacement of URLs with their

Change-Id: Ic19e45986e9f650c1deb297f463e679fd268ad97
2019-04-24 16:13:58 +08:00
Dmitry Tantsur 8f2d7587b0 Correct headings in README.rst
Currently it's titled "Team and repository tags", which is obviously
not the project name. Also the top-level title is duplicated twice.

Change-Id: Ida25b71ce4848db8355a7d133cdfcc4f00604d1e
2018-09-27 13:51:54 +02:00
Marc Methot dba2041324 Fixed link to Storyboard instead of launchpad
Change-Id: Ic92908461bc17bceaafe815a820b90cb2d3fc75d
Task: #22977
2018-07-13 09:04:16 -04:00
chenxiangui 970f45a342 Add release notes link to README
Add release notes url doc link to README.rst

Change-Id: If1f2dde51180f9e97c08329f504da541aafe5869
2018-06-12 14:28:27 +08:00
Julia Kreger 006950e3ca Update Launchpad references to Storyboard
While old launchpad links will still work,
we have process and contributor documentation
that needed to be updated.

Change-Id: I0890e09ba75a6ac8644ce2bea9292aab5b55cfb5
2018-04-09 12:37:14 -07:00
melissaml 9f912c0901 Update links in README
Change the outdated links to the latest links in README

Change-Id: Ib05c8fe8cfde3d3f04b7248aeb782d049412cc5c
2018-03-11 01:55:39 +08:00
fpxie 24272f67c9 [doc] Replace http with https
Replaces some occurrences of http with https in order to preserve the security
zone behavior and ensure that resources are referenced/accessed via https.
This doesn't replace all occurrences because some of the URLs in our docs
need to be changed.

Change-Id: Ia1fcd7cb8d1bbec0f7380293445220c7e7b3a43c
2017-08-21 17:41:52 -04:00
Sam Betts b1b22e885b Update README to point at new doc location
Change-Id: I96fcfa326c0f0a6dde88461dbfddd10ecfaa18ec
2017-07-06 13:06:08 +01:00
Flavio Percoco f123e4e397 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

To see an example of how this would look like check:


Change-Id: I96eebfd2f3c10a72a8805d67b63975d4f7d3ea23
2016-11-25 13:28:32 +01:00
Devananda van der Veen d0e49e1b41 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
2016-08-23 12:49:04 -07:00
daz 4e573f972d Update readme file
Minor edits to the readme file

Change-Id: I5ac6d78950a142ba3bac2b0b9595f1f3425f3b22
2016-08-17 09:11:58 +10:00
Ruby Loo f18ec74871 Mention RFEs in README
The README now mentions that we use RFEs (bugs)
instead of blueprints to track features.

Change-Id: I5b717981bdb1fa514f2fbc85e80e2e23e01beba2
2016-05-24 22:29:51 -04:00
Miles Gould 45763e1ffb Slightly reword README
"In concert" and "together" mean essentially the same thing, but
"together" is more idiomatic English and slightly simpler.

Change-Id: I91dd91b6b35c3b170f562103f2b54d4a2a9cf392
2015-10-19 14:23:21 +01:00
Doug Hellmann 16352e95b5 format links in the readme to work with the release notes tools
The release note generation tool expects to find certain URLs using
regular expressions so it can include them in the automatically
generated notes. Update the README to use the "standard" syntax for
those links.

Change-Id: Icc10a50b127a9dd3b033a8fac07fa2c08c124523
2015-08-26 15:46:49 +00:00
Jeremy Stanley eb150c51df Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Dropped sections that duplicate each other after the change.

Co-Authored-By: Dmitry Tantsur <>
Change-Id: I233df03368dbb4b7805d6dce28de00fa037353c7
2014-12-05 16:55:23 +01:00
Devananda van der Veen 92e7fc73db Update doc headers at end of Juno
- remove note that Ironic is incubated
- remove statements about Icehouse being beta quality
- add note to deploy/install-guide that it refers to Juno release

Change-Id: I1fb7059bdd01d2bd9a6d20c8f131d51608188451
2014-10-16 09:41:44 +01:00
Devananda van der Veen 0917048268 Remove duplication from README, add link to docs.
Change-Id: I1d4367cccc9669cf18987a6ca36f79a372303e16
2013-06-06 11:15:47 -07:00
Devananda van der Veen e177c381bd More updates to the README.
- Correct driver type names.
- Add more description about driver loading and implementation.

Change-Id: I145c7a64b9e5def4e103309ee3c9fe45204ae5d6
2013-05-23 09:08:02 -07:00
Chris Krelle acb05d4018 Add steps to README.rst
Add tox to pip install.
Add step to run testr init

Change-Id: I10fd120d7757bc11695d064d488024e545655448
Authored-by: Chris Krelle <>
2013-05-21 10:53:44 -07:00
Jenkins 25fa44edec Merge "Add some API definitions to the README." 2013-05-20 18:54:11 +00:00
Lucas Alvares Gomes 8a18c7abaf Update the README file development section.
Add more prerequisites to set up a local environment for development on
Ubuntu and the Fedora equivalents.

* libxml2 and libxslt are needed to build lxml.
* mysql libs are needed to build MySQL-python.

Change-Id: I4627b34ba72d677975c8c067e981fca732d78215
2013-05-20 18:33:21 +01:00
Devananda van der Veen 0515326f85 Add some API definitions to the README.
Change-Id: I549de0d298d030308971c2739bf1ff88ef9363e1
2013-05-20 09:35:32 -07:00
Devananda van der Veen 5b78a8d484 Add information to the project README.
Change-Id: I7f345369ded37167eb01e46e9aeb4e9d9940596e
2013-05-18 09:13:18 -07:00
Monty Taylor 84a7dc47e2 Added project infrastructure needs. 2013-05-02 14:55:43 -04:00