Project

General

Profile

Actions
Copy link

Idea #6774

closed

[Documentation] Better presentation/separation of install prerequisites

Added by Peter Amstutz over 8 years ago. Updated over 4 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
-
Category:
-
Target version:
-
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
Copy link
 #1

Updated by Peter Amstutz over 8 years ago

  • Subject changed from [Documentation] Better presentation/separation of prerequisites to [Documentation] Better presentation/separation of install prerequisites
  • Description updated (diff)
Actions
Copy link
 #2

Updated by Peter Amstutz over 8 years ago

Related idea, when we have instructions for several different linux distributions, we could use a tabbed view to switch between them to reduce the amount of vertical space used to enumerate every option.

Actions
Copy link
 #3

Updated by Peter Amstutz over 4 years ago

  • Status changed from New to Resolved
Actions
Copy link

Also available in: Atom PDF