5 Commits

Author SHA1 Message Date
zhangkunpeng
0568c4cc6e repair docs about installation_guide
Software Requirements in installation guide miss stx-tools project

Change-Id: Ic4631bb47f56585f89427036bd2883f5ac0dd961
Story: 2004088
Task: 28001
Signed-off-by: zhangkunpeng <zhang.kunpeng@99cloud.net>
2018-11-20 14:16:49 +08:00
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
Kristal Dale
e987f4a8f0 Update clone URL for stx-tools
- In Deployment Environment Setup section, update clone URL for stx-tools project to https://git.starlingx.io/stx-tools

Change-Id: Icaf6d4292defe2b38396f1318668e322348037a7
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-24 13:15:15 -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
Kristal Dale
ed5bddca67 Apply proposed doc organization and migrate wiki content
1. Updated index page to include toctree for proposed organization of docs. Updated sample content (this needs to be finalized - SAMPLE content only).
2. Added Installation Guide page. Migrated content from wiki to docs (reST).
3. Added Developer Guide page. Migrated content from wiki to docs (reST).
4. Updated Contribute page to link to 2 child pages
- Added API Contributor Guide page. Migrated content from wiki to docs (reST).
- Added Release Notes Contributor Guide page. Added draft content from etherpad (reST).
5. Removed trailing white space in files (patch)

Depends-On: https://review.openstack.org/#/c/611078

Change-Id: If4448fcc096f8fdcdf0d88c31b6b42ea94aea1fd
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-18 10:24:30 -07:00