Project

General

Profile

Actions

Bug #6687

closed

[Documentation] Improve flow of manual installation guide

Added by Brett Smith almost 9 years ago. Updated almost 9 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Radhika Chippada
Category:
Documentation
Target version:
Story points:
2.0

Description

Functional requirements:

  • Every installation page is self-contained. Read top to bottom, it tells you how to go from a typical base distribution install to running the desired service.
  • The installation guide flows linearly. If you follow it in order, when you get to the page where you install service X, you have already installed all the services that service X requires to function correctly.

Implementation:

  • Get rid of the "Software prerequisites" section.
    • For common components like RVM, Ruby, PostgreSQL, and nginx with Phusion Passenger, prepare Textile includes to describe how to install each one. Use these includes on the installation page for each service that requires them.
    • For services, move them to the "Manual installation" section.
  • Order the "Manual installation" pages as follows:
    1. Prerequisites
    2. SSO server
    3. API server
    4. Create standard objects
    5. Git server (arv-git-httpd)
    6. Keepstore
    7. Keepproxy
    8. Crunch dispatcher
    9. Compute node
    10. Shell server
    11. Workbench
    12. Cheat sheet

A note about scope: because you're making big changes to a lot of pages, you'll be tempted to fix every issue on those pages. Don't do it! Fixing every bug in the documentation is emphatically out of scope—we have plenty of other stories to address those.


Subtasks 1 (0 open1 closed)

Task #6729: Review branch: 6687-install-guide-flowResolvedRadhika Chippada07/22/2015Actions
Actions

Also available in: Atom PDF