Jump to: navigation, search

Difference between revisions of "Documentation/InstallGuideWorkItems"

(For projects to create a guide)
(For projects to create a guide)
Line 37: Line 37:
=== 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:
# NOTE(jaegerandi): this target does not use constraints because
# upstream infra does not yet support it. Once that's fixed, we can
# drop the install_command.
install_command = pip install -U --force-reinstall {opts} {packages}
commands = sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html
* Add openstackdocs-theme to test-requirements.txt file.
* Once the changes above are merged, add jobs for it, see https://review.openstack.org/#/c/326039/ for details.

Revision as of 10:53, 9 June 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

  • 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)

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

  • 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).
  • Create new chapter “project specific install guides” as skeleton.
  • Create new project-specific install guides section on http://docs.openstack.org .
  • Create example jobs for publishing of project-specific install guides (jaegerandi): https://review.openstack.org/#/c/326039/
  • Work with operator tags team to amend the ops:docs:install-guide tag (thingee)
  • Create a “cookie cutter” template for use by projects when creating new Install Guides: done

For projects to create a guide

This is documented in the Contributor Guide.