Jump to: navigation, search

Difference between revisions of "Documentation/InstallGuideWorkItems"

(Project-Specific Install Guides)
(Project-Specific Install Guides)
 
(24 intermediate revisions by 4 users not shown)
Line 7: Line 7:
 
Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/installguidenewton
 
Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/installguidenewton
  
* Update the title (OpenStack Installation Tutorial) to reflect that it is for training and not production, and add preamble to explain that purpose.
+
* <s>Index page is complete (https://review.openstack.org/#/c/331704), needs updating to improve layout</s>
* Document from packages to best use existing content, but continue to revisit this problem over time, as more data emerges about which installation method users prefer.
+
* <s>Update the title (OpenStack Installation Tutorial) to reflect that it is for training and not production, and add preamble to explain that purpose.</s>
* Edit the existing content so that it uses manual configuration only.
+
* <s>Document from packages to best use existing content, but continue to revisit this problem over time, as more data emerges about which installation method users prefer.</s>
 +
* <s>Edit the existing content so that it uses manual configuration only.</s>
 
* Create scripts that can be run and automatically tested and include snippets of these scripts verbatim in the guide. This will accelerate testing of the guide.
 
* Create scripts that can be run and automatically tested and include snippets of these scripts verbatim in the guide. This will accelerate testing of the guide.
* Create a ‘cookie cutter’ template that can be used for all services (AJaeger): https://review.openstack.org/#/c/314229/
+
* <s>Create a ‘cookie cutter’ template that can be used for all services (AJaeger): https://review.openstack.org/#/c/314229/</s>
* Document the process of adding a big tent project under the new governance, including what tests and dependencies are required.
+
* <s>Document the process of adding a big tent project under the new governance, including what tests and dependencies are required.</s>
* Move Shared File Systems (Manila), Object Storage (Swift), Orchestration (Heat), Telemetry (Ceilometer), Database (Trove) to project repositories and link them in the “Additional projects” chapter.
+
* <s>Move Shared File Systems (Manila), Object Storage (Swift), Orchestration (Heat), Telemetry (Ceilometer), Database (Trove) to project repositories and link them in the “Additional projects” chapter.</s>
** Orchestration (pkovar)
+
** <s>Orchestration</s> (pkovar)
** Shared File Systems (gouthamr)
+
** <s>Shared File Systems (gouthamr)</s>
** Object Storage (pkovar)
+
** <s>Object Storage (pkovar)</s>
** Telemetry (ildikov)
+
** <s>Telemetry</s> (ildikov)
 +
** <s>Database</s> (Laurel Michaels, Andreas Jaeger)
  
 
== Project-Specific Install Guides ==
 
== Project-Specific Install Guides ==
Line 25: Line 27:
 
Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/projectspecificinstallguides
 
Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/projectspecificinstallguides
  
* Move projects that are now out of scope of the basic install guide into in their own repositories. Also, create initial skeleton for these project specific install guides so that project teams have a consistent starting point that others can follow as example. This affects: Orchestration (heat), Telemetry (telemetry), Object Storage (swift), Shared File system (manila).
+
* <s>Move projects that are now out of scope of the basic install guide into in their own repositories. Also, create initial skeleton for these project specific install guides so that project teams have a consistent starting point that others can follow as example. This affects: Orchestration (heat), Telemetry (telemetry), Object Storage (swift), Shared File system (manila).</s>
** Orchestration (pkovar): https://review.openstack.org/#/c/325389/
+
** <s>Orchestration (pkovar): https://review.openstack.org/#/c/325389/ Merged</s>
 
** Shared File Systems (gouthamr): https://review.openstack.org/#/c/317152/
 
** Shared File Systems (gouthamr): https://review.openstack.org/#/c/317152/
** Object Storage (pkovar)
+
** <s>Object Storage (pkovar): https://review.openstack.org/#/c/330070/</s>
** Telemetry (ildikov)
+
** <s>Telemetry (ildikov): https://review.openstack.org/#/c/330051/ Merged, https://review.openstack.org/#/c/330048/ Merged</s>
* Create new chapter “project specific install guides” as skeleton.
+
** <s>Database (jaegerandi): https://review.openstack.org/#/c/330540/</s>
* Create new project-specific install guides section on http://docs.openstack.org .
+
* <s>Create new chapter “project specific install guides” as skeleton: https://review.openstack.org/#/c/342190/ - merged</s>
* Create example jobs for publishing of project-specific install guides (jaegerandi): https://review.openstack.org/#/c/326039/
+
* <s>Create new project-specific install guides section on http://docs.openstack.org - http://docs.openstack.org/project-install-guide/draft/ </s>
* Work with operator tags team to amend the ops:docs:install-guide tag (thingee)
+
* <s>Create example jobs for publishing of project-specific install guides (jaegerandi): https://review.openstack.org/#/c/326039/ Merged</s>
* Create a “cookie cutter” template for use by projects when creating new Install Guides: done
+
* <s>Work with operator tags team to amend the ops:docs:install-guide tag (thingee)</s>
 +
* <s>Create a “cookie cutter” template for use by projects when creating new Install Guides</s>
  
 
=== For projects to create a guide ===
 
=== For projects to create a guide ===
''This is a first draft, please help refine it''
+
 
* Move existing content over to repository or start with new content using the installguide-cookiecutter from https://git.openstack.org/cgit/openstack/installguide-cookiecutter.
+
This is documented in the [http://docs.openstack.org/contributor-guide/project-install-guide.html Contributor Guide].
* Include tox.ini environment for 'install-guide' like:
 
* Once it's merged, add jobs for it, see https://review.openstack.org/#/c/326039/ for details.
 
* TBD
 

Latest revision as of 06:14, 16 August 2016

Install Guide Work Items

Existing Install Guide

Spec: http://specs.openstack.org/openstack/docs-specs/specs/newton/installguide.html

Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/installguidenewton

  • Index page is complete (https://review.openstack.org/#/c/331704), needs updating to improve layout
  • Update the title (OpenStack Installation Tutorial) to reflect that it is for training and not production, and add preamble to explain that purpose.
  • Document from packages to best use existing content, but continue to revisit this problem over time, as more data emerges about which installation method users prefer.
  • Edit the existing content so that it uses manual configuration only.
  • Create scripts that can be run and automatically tested and include snippets of these scripts verbatim in the guide. This will accelerate testing of the guide.
  • Create a ‘cookie cutter’ template that can be used for all services (AJaeger): https://review.openstack.org/#/c/314229/
  • Document the process of adding a big tent project under the new governance, including what tests and dependencies are required.
  • Move Shared File Systems (Manila), Object Storage (Swift), Orchestration (Heat), Telemetry (Ceilometer), Database (Trove) to project repositories and link them in the “Additional projects” chapter.
    • Orchestration (pkovar)
    • Shared File Systems (gouthamr)
    • Object Storage (pkovar)
    • Telemetry (ildikov)
    • Database (Laurel Michaels, Andreas Jaeger)

Project-Specific Install Guides

Spec: http://specs.openstack.org/openstack/docs-specs/specs/newton/project-specific-installguides.html

Blueprint: https://blueprints.launchpad.net/openstack-manuals/+spec/projectspecificinstallguides

For projects to create a guide

This is documented in the Contributor Guide.