4 Commits

Author SHA1 Message Date
Kristal Dale
c92b00d074 General clean up of presentation; migrate release notes from wiki
- Landing page:
	- General clean up (org of page, improve wording, markdown clean up)
	- Replace Abstract with welcome text, move link to project spec to welcome.
	- Include ref to contribute guide in Contribute section
	- Remove "Contents" caption from toctree (so it wont render in side nav)
- Release notes page:
	- Remove "StarlingX" from page title.
	- Integrate wiki content from https://wiki.openstack.org/wiki/StarlingX/stx.2018.10_Release_Notes
        - Improve wording, link text
- API ref page: Update page title to "REST API Reference"
- All pages:
	- Capitalization corrections
	- Clean up section heading markdown for consistency
- libvert installation page:
	- corrected heading levels (I believe section headings got swapped so they weren't in the correct hierarchy)

Change-Id: I8b7a8cd143e335dd27cd2dc6241fd25a6374bd5d
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-11-13 14:44:17 -08:00
Scott Rifenbark
91fb2dc036 API Reference Docs Landing Page
Updated three "index.html" files to remove the "Software Updates"
link from two API ref landing pages and one general StarlingX
doc landing page.  The link appeared in three areas:

The "Software Updates" page no longer exists.

Change-Id: Ib54057ad840b2fd0029ef5da03addaf621d0c731
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-10-25 09:22:11 -07:00
Abraham Arce
ad56abc446 [Doc] Installation Guide Xml Definitions
Installation guides should list the XML server definitions for each
configuration:

- Controller-N
- Compute-N
- Storage-N

Additionally, where it applies:

- Add method to power up virtual servers.
- Reword system configuration section.
- Use host-if-modify syntax valid for current release.

Minor changes:

- Remove DRAFT from the top of Release Notes Contribute Guide.
- Fix api-ref broken links

Change-Id: I2aed6a2dadd58bf5f701f15b94257afd5d79e6de
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-23 08:08:32 -05:00
Dean Troyer
e3a11084e2 Add project links and pages for API Ref and Release Notes
The project-specific docs are published independently so we need
to maintain the links into those subtrees (/stx-*), also
for the api-ref (/api-ref/stx-*) and releasenotes (/releasenotes/stx-*).

Also add docs env to the default list in tox.ini.

Change-Id: If68e6c984d684af05124b3252a8ff3c4b44b6d82
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-18 19:13:22 -05:00