Extend newfile script to generate unique filenames for
include files.
Update instructions in Contributor guide
Include correct version of new-topic.sh
Fix script output in Contributor guide
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I049adb2a8b8b028c45e2fc4f951db664e4777550
Created archive folder and moved old config guides.
Added links to replacement guides in old guides/stubs.
Change-Id: I0a911497aacf9b741d41524d11262531c5c17f53
Signed-off-by: MCamp859 <maryx.camp@intel.com>
Add Gerrit training for doc reviewers to the
resources folder.
Add index-resources file.
Add training PDF and link on Contribution page.
Trying reference directive.
Removed changes on Contribution page for now.
Change-Id: I2b1526c1d03e4ccb20d53331a1d6586aad7ead63
Signed-off-by: MCamp859 <maryx.camp@intel.com>
This patch adds a brief description about contributing a new
blog post to the StarlingX website.
Change-Id: Ifec9958fa3d87bf6e29d4b1e6f0d6b107541eacc
Signed-off-by: Ildiko Vancsa <ildiko.vancsa@gmail.com>
Instructions for using unique import generator submitted under
https://review.opendev.org/c/starlingx/docs/+/810950
Incorporated review comments.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I72de341a99b8fc1308fb769119896247caf073ce
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Changed paths to avoid '..', which breaks symlinks in newer versions of sphinx.
Consolidated installation include files under /_includes. Prefixed r5 versions with 'r5_'
Moved files that are used up/down, but at different paths under /shared/_includes
and /shared/figures
Move two include files to /_includes
Moved addtional images to /shared/figures/... Required for DS platform builds.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ia38f4205c5803b3d1fc043e6c59617c34a4e5cbd
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Updated 2 files to change OpenStack Foundation to the new name
Open Infrastructure Foundation.
Change-Id: I59d15ea984cf9e8611fb5af86aac6f3cd726bb87
Signed-off-by: MCamp859 <maryx.camp@intel.com>
Updated conf.py to enable "show_other_versions"
Made clerical edits to test new theme output
Change-Id: I7637a18204004383220ae723cb42eb94e4d5bebd
Signed-off-by: MCamp859 <maryx.camp@intel.com>
Added new guide to developer resources and contributor pages.
Alphasorted list of guides on developer resources page.
Closes-Bug: 1873500
Change-Id: I2344a437ef85c1352ac9f6a5da0a8ac64ff78f1a
Signed-off-by: MCamp859 <maryx.camp@intel.com>
Updated link on Contributor Guides page to point to guide.
Closes-Bug: 1877628
Change-Id: Ifb6e15a76943553c8d1da8f2331ec0d358db6bb5
Signed-off-by: MCamp859 <maryx.camp@intel.com>
Update the Documentation Contributor Guide to use the existing
OpenStack doc contribution guides (for setup, making changes, making
a commit, making a review).
Change-Id: I6b0ffff61e71dd5a90d038841348d90e206c41ec
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
At somepoint documentation was re-organized and the references to the
the build_guide pointed to the wrong locations, this fixes that.
Change-Id: I581ce6b06103daf6883ab8cb47274a4208e0ad49
Signed-off-by: Saul Wold <sgw@linux.intel.com>
Add a brief description and a link to the new log collection tool to the dev
process document.
Change-Id: I3bf5595f25e8a5ea811a41db9f9c4869d8877f2a
Signed-off-by: Bruce Jones <bruce.e.jones@intel.com>
Change the wording from project to repository for correct
reference in doc/source/contributor/api_contribute_guide.rst.
Change-Id: I7f99d2add2535b054e05514aecfeac8814f34b90
Signed-off-by: Ildiko Vancsa <ildiko.vancsa@gmail.com>
- Simplify docs contribution guide, using refs to OpenStack docs
- Minor formatting edits in other guides to make consistent
- Move doc to developer resources
- add link(s) to wiki from landing page
Patchset 2: Added ordered and enumerated lists, wording improvements per feedback.
Change-Id: I3b15a8127c0d742d726389e2b561424fca82567c
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
- Add Get Started section to landing page
- Replace Contribute section with note welcoming contributions (with links)
- Split Documentation section into Installation Guides, Config, Operation Guides
Reference, General info sections (Improve scanability of topics)
- Move note re using OpenStack CI/CD and repo link to Contribute page.
- Replace link to spec with link to wiki (more relevant to new users)
- Move projects section/list to StarlingX Introduction.
Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
The git links are error,this change is to correct all them.
Closes-Bug: #1853958
Signed-off-by: lihang <lihang0166@fiberhome.com>
Change-Id: I1e7975b9c46ca8f9d2f34c9163997c4a783c1abf
Add a development process document to the docs tree replacing the
current Bugfix and Feature dev process wiki pages.
Patchset 2: Add an introduction, a list of Personas, and pointers to
the basic git workflow. Add some initial text to the Test and Docs
sections. This addresses Ildiko's initial feedback.
Patchset 3: Add a description of the defect handling process, which
is pretty much a cut-n-paste from the wiki page. We can update the wiki
to point to this doc once the doc merges.
Patchset 4: Add a description of the feature submission process, copied
and slightly changed from the wiki.
Patchset 5: Fix tox issues.
Patchset 6: Address Bart's feedback and thank you!
Patchset 7: Add "Basic git workflow" section.
Patchset 8: Address Saul's feedback. Changed "Author" to "Developer".
Patchset 9: Really address Bart's feedback :)
Patchset 10: Address Saul's feedback.
Patchset 11: Restructure the doc to improve readability. Remove the
"small change" section. Fix several minor issues.
Patchset 12: Address Bart's feedback. The bug triage process needs
to be discussed with the community.
Patchset 13: General cleanup. First draft of the Feature Development
process.
Patchset 14: Address feedback from Bart and Dariush. Remove WeChat
as a recommended comm channel. Move spec development prior to
planning phase and note the dependency. And a few minor cleanups.
Patchset 15: The draft is complete and ready for broader review. This
is no longer WIP.
Patchset 16: Address Bart's feedback.
Patchset 17: Address feedback from Ghada, Brent and Dariush.
Patchset 18: Address Kris and Abraham's feedback.
Patchset 19: Address Ian's feedback by adding clear direction
and responsibilities for developers to create and run automated
test cases before checking in code.
Patchset 20: Minor formatting edits (reST syntax consistency)
Story: 2005173
Change-Id: Ia29b3ccbcf690a1ebc7649fe9ae3370936f7a352
Signed-off-by: Bruce Jones <bruce.e.jones@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
The link to the webpage in docs are error,
so redirect them to the correct link.
Change-Id: I7273784b1b9eaae42e4a76c98ceed6202ddcf915
Closes-Bug: #1852840
R1 and R2 build guides were identified as being nearly identical.
Based on this, they were consolidated into a single guide.
- Updated link to reference consolidated guide
- Updated index page to reference consolidated guide
- Removed old versioned guides
- Basic formatting cleanup (remove $prompts, lists, indentation)
Change-Id: I83aea4d76147fbc56d555dff3ce768737d15c4e2
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
- Update the R2 directory from 'current' to 'r2_release' in: build guides,
install guides. This will enable persistent URLs for each release.
- Minor edit to remove reference to versioned content in developer resources
(there is no versioned content for developer resources)
Change-Id: I336117a12a2c103e9e16739e3a8fed1d1d83683d
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
- Migrated reorged content from wiki
- Naming, title, and capitalization consistency, minor rewording in sections
- Set up includes to reuse common content across pages
- Introduction: remove 'openstack users' and 'kubernetes users'
- Consolidate term definition into Key concepts page
- Archive R1, move R2 to current releast, set up for R3
- Remove stub pages for duplicate content, or content deferred to R3
- Rework intro and contribute pages for better readability
- Split Key concepts into two pages: Terms and Deployment Options
- Pass for grammar, punctuation, licensing, etc.
- Pull streamlined intro content into R2 install guides (from prev version)
- Added R2 release note page
- Update links to projects/project names to remove the "stx-"
- Add instructions for creating a bootable USB
Story: 2006315
Task: 36046
Change-Id: I38656fd382d1d9cf2969812c548fb7b2dc9dd31e
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
OpenDev is community-run tools and infrastructure services for collaboratively
developing open source software [0]. A new structure has been assigned
including the new named "tools" repository which hosts the scripts to build
an StarlingX ISO image.
[0] http://lists.starlingx.io/pipermail/starlingx-discuss/2018-November/001821.html
Change-Id: Ie326347d3f4a0016d1093fc05a2eba61f02a052e
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Changes included updating the StarlingX docs landing
page to conform to a new list of available documents
as follows:
* StarlingX Introduction
* Deployment Guides
* Installation Guides
* Developer resources
* Operation Guides
* Project Specifications
* REST API Reference
* Release Notes
* Contribute
So-called "dead-end" links have an explanation of content
coming. Any destination associated with an existing story
ID have the link to the story for reference.
The existence of a "current" and "latest" Developer
Guides resulted in the top-level list of doc resources
including both the "Developer Guides" and
"Developer Resources" bullets. Ideally, the Developer
Guides would be included as part of the "Developer
Resources" area. For "latest" they are. However, for
"current" I left them alone since the 2018.10 release
is out there. This organization can settle out as more
releases launch.
Finally, I did not focus on the writing aspect for this
PR. That part can be cleaned up going forward.
Change-Id: I0442e948d5d9a41add9eb3bdde8882c157a8f752
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>
- 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>
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>
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>
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>
