Commit Graph

8 Commits

Author SHA1 Message Date
Luigi Toscano 4a44010f31 doc: restructure the image building documentation
Main goal: consolidate the information about image
building under the same documentation page, and move
plugin-specific details inside plugin pages.
No plugin-specific information should live outside
those pages.

More details:
- move the detailed documentation about sahara-image-pack
  from the contributor guide to the new dedicated page
  in the user manual;
- remove the vanilla and cdh pages which describes building
  images with sahara-image-create, and move the common
  information to new sahara-image-create page
  in the user manual;
- add the matrix of supported plugin versions and
  supported building technology for each plugin inside
  the respective <plugin>-plugin.rst;
- add the redirects for the removed pages (only for master
  and rocky, where this change should be backported).
- remove few details not really needed (e.g. how to convert
  to VMDK images, location of cloud-init packages, etc,
  which do not really belong here).

Change-Id: I8398a7ad625276d8f11d743688ba71902a7e1adc
2018-10-18 15:15:35 +02:00
Luigi Toscano 455b456ad3 doc: light cleanup of the ironic-integration page
Remove the commands required to configure the nodes, the resources
and the flavors and refer to the Ironic documentation instead.

This change also removes the only reference in Sahara to the
old pxe_ipmitool driver, which is going to be removed:
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128438.html

Remove also the reference to a bug which was fixed for a (long) while.

Change-Id: I5366298f82afb928b7c7520e2eb815d3ff597885
2018-06-08 16:54:01 +02:00
Luigi Toscano 39e7c2d320 doc: external link helper for other projects' doc
The external link helper makes sure that the generated link
respects the current branch (latest for master, <release_name>
when built on stable/<release_name>.

Do not use it for sahara-tests (which is branchless).

Change-Id: Ie37fe37858a41f54558642ea93a75365668ef573
2018-06-08 16:08:50 +02:00
chenpengzi 339e1ad30f Replace chinese quotes
Change-Id: I39f1b5efad55a3c20d09bde8280b95c5f146b490
2018-02-05 17:24:37 +08:00
caowei 0329f526c3 Remove extra "$" in sahara-on-ironic.rst
Change-Id: I03b1f2ad8c24227f9aee4c57990adffbc4cde3fd
2017-12-03 17:42:26 +08:00
Guo Shan b94140e92e Incorrect indent Sahara Installation Guide in sahara
Incorrect indent Sahara Installation Guide in sahara cause wrong
front format.
Closes-Bug:#1729530
Change-Id: I419cd7dbcf9d7f7dadda5d4c7ebf75af64ef2081
2017-11-06 02:42:53 +00:00
Luigi Toscano 5662d84690 doc: point to the main git repository and update links
- no need to refer to github; point to the main repositories
  on git.openstack.org and remove the requirement for a github
  account in order to contribute;
- update few links which have been moved around and fix at least
  the associated message of a link;
- link to the website for HTTPie.

Change-Id: Ib310815d346e2364de1a2282f3f1e2d94590c3d2
2017-08-21 15:15:47 +02:00
Luigi Toscano a70a74aa23 Restructure the documentation according the new spec
Group the existing pages in the new top-level categories; each
category can be seen as a separate document and it has its own
index file.
The content of the pages was not changed, with the obvious
exception of the links between pages.

The autogenerated configuration has not been added yet to
configuration/; it will be fixed in a future commit.

At the same time, as suggested by the doc team, consistently
use only one separator in file names (dash, '-') instead of a mix
of dashes, dots and underscores. This may break even more links on
the Internet, but we are breaking them anyway by moving files.
Redirects can be set, but not in this commit.

Closes-Bug: #1706184
Change-Id: I5a10378d9da2603d617ad4193ea8d90e2afc5104
2017-08-04 18:05:40 +02:00