11 Commits

Author SHA1 Message Date
Joao Victor Portal
13160ffba7 Add information about RBAC policy of StarlingX API
Story: 2010149
Task: 46653

Signed-off-by: Joao Victor Portal <Joao.VictorPortal@windriver.com>
Change-Id: Ic073a6b7b8a49c04c9360bc60e87906048d7907e
2022-10-26 12:44:19 -03:00
MCamp859
08debb083b Update path in api-ref index
Update path in api-ref index file so the links work
in the R5 branch.

Change-Id: I0fd992800350617ed42a27a8bb9073d587f1aeda
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-05-05 15:06:56 -04:00
Stone
67d9204973 PTP Notifications
Made list alphabetical
Added PTP Notifications API to list of API links.

Signed-off-by: Stone <ronald.stone@windriver.com>
Change-Id: Id92cd6e1982a74cd73ba2917e9504835faae57d8
Signed-off-by: Stone <ronald.stone@windriver.com>
2021-03-15 07:16:17 -04:00
MCamp859
5f12efc83b Remove OpenStack API extensions
Updated API landing page and deleted source files.

Closes-Bug: 1877285

Change-Id: I03a91fcc101282794a198d0bf26763b67e31fb55
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-05-16 17:27:20 -04:00
Kristal Dale
7edaf9f52e Update doc contribute guide and api ref page to use
updated repo/project names

- updated doc contribute guide to use updated project names
- updated doc contribute guide to remove explicit display of
  project directory structure (it has changed)
- update api ref landing page to use updated project names in URL

Change-Id: I05779f9ac0c465f6ed928bc68f333e37275dcb4d
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-28 16:38:49 -07:00
Dean Troyer
80e465ebba stx-update: API Ref Doc Content Enabled
API Reference content has been added for stx-update:

  - Add link and pages for API Ref and main page.

The project-specific docs are published independently so we need
to maintain the links into those subtrees, for the api-ref (/api-ref/stx-*).

This change was introduced and then reverted due to this abandoned
commit:
  https://review.openstack.org/#/c/605278/
Reason was a confussion during the split of old API into the new
API scheme.

Depends-On: https://review.openstack.org/#/c/634994/
Change-Id: I3a4bd5e98cf7077cf4c3abe037d1a0f6d8c69fcf
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2019-02-05 04:20:11 -06:00
Kristal Dale
330bb531fa Remove search ref
Remove static search reference from REST API reference page until
such time as it is needed in the stx-docs repo. Static search will
search only the repo, and not other reps (which may be misleading).

Change-Id: If0fb4468cdbc88eced379573378c849a61836d4b
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-30 15:05:48 -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
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