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>
Removed duplicate entry in conf.py for version and release
variables. Set both version and release to empty string, so
that the string above left nav renders only the project name.
Story: 2004900
Task: 29220
Change-Id: I7dbbbd78dc33841baec32ef1d48a5ab3dc1fd860
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
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>
"Mad" is a legacy name used for StarlingX deployments, let's change
to "Stx".
Story: 2004794
Task: 29033
Depends-On: https://review.openstack.org/#/c/612826
Change-Id: I6aa98d86c6929d453f351ad9ccc5bf0bf83385fe
Co-authored-by: Saul Wold <sgw@linux.intel.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Include ISO image location at CENGN’s StarlingX mirror.
Change-Id: I455494f15b1cc3a722c0623c031b5ccc35b40581
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Up to 4x Compute Nodes can be added the the AIO-Duplex Deployment:
- Limited to 4x Compute Nodes as the Controller Function on the AIO
Controllers has only a portion of the processing power of the
overall server.
- Virtual machines can be scheduled on either of the AIO Controller Nodes
and/or the Compute Nodes.
- Allows a capacity growth path for someone starting with an AIO-Duplex
deployment.
Note. "Compute" personality is still referenced due to upcoming changes how
versioning is handle at documentation level, once the implementation is in
place, personality will be modified to "Worker".
Story: 2004780
Task: 28913
Change-Id: I50526dea07ec34f1d01bfbb4cbed34ba2f2366fd
Co-authored-by: Greg Waines <greg.waines@windriver.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
The current building process involves a serie of steps that can be simplified
in order to do the process/experience more user friendly for our end users:
- Unification of Docker files into one allows to build base container via a
single make call.
- Remove the copy of git configuration file since it will be generated.
Based on the unification to one Dockerfile, our Developer Guide
new "flow" is:
- Prepare Base Docker Image
- Build "base image"
- Build the CentOS Mirror Repository
- Run container from "base image"
- Get mirror files
- Create StarlingX Packages
- Run container from "base image"
- Get StarlingX source code
- Build StarlingX packages
- Build StarlingX ISO
Story: 2003712
Task: 28010
Change-Id: I5776a7c515a7f2f1f3355644092b1d0a913f1ee8
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Under section Installation Requirements and Dependencies on
Developer Guide:
- create a user
- add the user to Docker group
Closes-Bug: 1799611
Change-Id: I39e95b096bdf12f8ed76237066fc9a3f17cadcdb
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Before creating a storage function (an OSD) in Storage-0, at least 2
unlocked and enabled hosts with monitors are required:
- Controller-0
- Controller-1
Change-Id: Iba2d1e14d0feba2bc57e2c4fafc8dcb38358fc9d
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Update the instructions to copy the generated installer files.
Change-Id: I4294cd66b9e3e17a7d9221587cdf19dc606c431e
Signed-off-by: Erich Cordoba <erich.cordoba.malibran@intel.com>
Converted the guide to use the "r/2018.10" branch rather than the
default "master" branch. Cleaned up a lot writing with general
edits. Applied consistent formatting across various items such
as filenames, pathnames, etc. I went through the entire file and
did some clean-up work.
Change-Id: If53ab66187307c087f5ae755f44d6080d1aa8245
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
This change adds example git clone commands to the documentation
contributor's guide to show them how to find the proper git repos.
Closes-Bug: 1809285
Change-Id: Iecd02ac18be0ee46771928ecc16660ce44d86883
Signed-off-by: Bruce Jones <brucej@localhost.localdomain>
I have created the initial draft of a new StarlingX guide called
"Documentation Contributor Guide". The guide lives alongside
the existing StarlingX contributor guides. This involved an
update to the contributor folder's "index.rst" file and a new
content file named stx-docs/doc/source/doc_contribute_guide.rst".
Change-Id: I54adedb520869bed462dfee30098404a09dfca8e
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Added Small HW form factor information for simplex and
duplex AIO hardware requirements.
Closes-Bug: #1804024
Change-Id: Ia921979c8887a7e25eef6dc9273274438a72356d
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
- 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>
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>
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>
We want that in the nav sidebar, use a full URL because that
subtree comes from stx-specs with its own index.rst.
Change-Id: I8a6cda4071405a40b4a3385c80e99579c1b370e1
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
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>
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>
* Add pointers in the main doc to api-ref and releasenotes pages
* Add publish-stx-api-ref job
* Add search at bottom of api-ref and relnotes pages to trigger the jobs
* Add openstackdocstheme installation into requirements file
Change-Id: I11db7e584f3e16f1fd0517a5c0059bdc2d448399
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
We have the AFS volume and now a publish job, let's see if we
can get from here to there. Include a docs change to ensure
the jobs actually run.
the web server is near, pending certificate installation.
Change-Id: I325e97f0500e66b57b7d1cd2d2e81bee79c67f30
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
Baseline changes to comply with OpenStack API documentation
from OpenStack Documentation Contributor Guide [0] for
the following StarlingX staging repos:
- stx-python-cinderclient
- stx-nova
- stx-glance
- stx-neutron
Changes:
- [1] How to document your OpenStack API service
- Adding SPDX-License-Identifier: Apache-2.0
[0] https://docs.openstack.org/doc-contrib-guide
[1] https://docs.openstack.org/doc-contrib-guide/api-guides.html
Story: 2002712
Task: 26728
Change-Id: Ie8a142360b7c57d7ec477559757aa8295feb09ff
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Start with building Sphinx, include links to the anticipated locations
for /releasenotes and /specs.
Change-Id: I111e4dfc2a31a97b869df25e0d059b8423d25d6a
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
