Project

General

Profile

Actions

Idea #17272

open

Doc site feedback

Added by Peter Amstutz over 3 years ago. Updated 7 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
Documentation
Target version:
Start date:
Due date:
Story points:
-
Release:
Release relationship:
Auto

Description

  • How you interact with Arvados in the big picture
    • Getting started
    • Guiding you to the right section based on what you want to do
    • Quick start -- bare minimum you need to know
  • Organize around personas:
    • User (do stuff with command line and web)
    • Developer (create pipelines, create stuff using API)
    • Admin (install & manage system)
  • More user-oriented sections instead of developer / devops
  • Put SDK/API/Architecture under "Developer reference"
  • Architecture showing each subsystem and which components are involved
  • Better layout for sections instead of very tall table of contents
  • Glossary
  • Better front page
    • Shrink the front page banner with Dax
    • Replace lower right "Sections" (redundant) with information
  • What to do with the top bar
    • Maybe turn it into breadcrumbs to get back out
  • Reference section of all the command line tools (with how to install / use)
  • New documentation for the "arvados-client" and "arvados-server" subcommands.

First step do some wireframes / mockups / sketches of new layout.

Actions #1

Updated by Peter Amstutz over 3 years ago

  • Status changed from New to In Progress
Actions #2

Updated by Peter Amstutz over 3 years ago

  • Status changed from In Progress to New
  • Category set to Documentation
  • Description updated (diff)
  • Tracker changed from Bug to Idea
Actions #3

Updated by Peter Amstutz over 3 years ago

  • Description updated (diff)
Actions #4

Updated by Peter Amstutz over 3 years ago

  • Description updated (diff)
Actions #5

Updated by Peter Amstutz over 3 years ago

  • Description updated (diff)
Actions #6

Updated by Peter Amstutz over 3 years ago

  • Description updated (diff)
Actions #7

Updated by Peter Amstutz over 3 years ago

  • Target version deleted (2021-02-03 Sprint)
Actions #8

Updated by Peter Amstutz over 1 year ago

  • Release set to 60
Actions #9

Updated by Peter Amstutz 7 months ago

  • Target version set to Future
Actions

Also available in: Atom PDF