Project

General

Profile

Actions

Idea #6774

closed

[Documentation] Better presentation/separation of install prerequisites

Added by Peter Amstutz almost 9 years ago. Updated over 4 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
-
Category:
-
Target version:
-
Start date:
Due date:
Story points:
-

Description

The install documentation now includes sections on how to install prerequisites such as Ruby and PostgreSQL. These sections take up a lot of page space and there is a lack of visual cues for where the prerequisites documentation ends and the Arvados specific documentation begins. In addition, the SSO, API and Workbench sections all start with the same text, so a user who is following the instructions might

Suggestions:

  • Table of contents at the top of each install page
  • Better visual separation between sections (possible suggestions: bigger vertical margins, horizontal rules)
  • Add section folding (bootstrap feature) so that documentation sections can be collapsed/expanded.
Actions

Also available in: Atom PDF