Jump to: navigation, search

Difference between revisions of "Documentation/InstallGuideWorkItems"

(Project-Specific Install Guides)
(Existing Install Guide)
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.
+
* Index page is complete (https://review.openstack.org/#/c/331704), needs updating to improve layout
 +
* <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>
 
* <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>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>
 
* <s>Edit the existing content so that it uses manual configuration only.</s>

Revision as of 23:00, 5 July 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.