This review adds information about the service-discuss mailing list
to the Contributor's Guide.
Review updates based on patchset 1 comments.
Closes-Bug: 2009185
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I8b8e3dec17fd285e288aaa24c0a48cd6fc82068c
Based on sphinx spellchecker testing/refinement.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ibfe9b6d7bc8bf044a7fff0ac7e362e4067b17989
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>
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>
- 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 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>
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>
