Project

General

Profile

Actions

Idea #16055

open

User guide update planning

Added by Peter Amstutz almost 5 years ago. Updated 30 days ago.

Status:
In Progress
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Start date:
Due date:
Story points:
-

Description

Make a specific plan for what we are going to do to update the documentation.

From discussion -- initial plan should be the minimal things that need to be updated 1:1 from workbench 1 documentation to workbench 2 documentation.

Follow up plan for a more complete overhaul:

https://docs.google.com/document/d/1yOU2gTV21MhQ6uieKrRJgJDGZq1epFPojJomS2Tg6WI/edit?usp=sharing

I think the biggest short term improvement would come from splitting the user guide into separate toplevel walkthrough/tutorial and reference sections and mainly reorganizing what we already have.


Related issues

Related to Arvados Epics - Idea #16557: Reorganize user guide, update for wb2In Progress01/01/202305/31/2024Actions
Has duplicate Arvados - Idea #19222: Planning for user guide rewriteDuplicateSarah ZaranekActions
Actions

Also available in: Atom PDF