Bug #6687
Updated by Brett Smith over 9 years ago
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: *# Prerequisites *# SSO server *# API server *# Create standard objects *# Git server (arv-git-httpd) *# Keepstore *# Keepproxy *# Crunch dispatcher *# Compute node *# Shell server *# Workbench *# 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.