StatCan / aaw

Documentation for the Advanced Analytics Workspace Platform
https://statcan.github.io/aaw/
Other
67 stars 12 forks source link

Draft User Documentation in Both Official Languages for BTIS #1920

Closed bryanpaget closed 5 months ago

bryanpaget commented 6 months ago

Study the documentation found here (internal link) and from this create an outline / sketch / rough draft / initial draft of user training documentation to help new users get started with the AAW.

Track work here: https://jirab.statcan.ca/browse/BTIS-49

bryanpaget commented 6 months ago

What components in our documentation should be changed?

bryanpaget commented 6 months ago

The Getting Started page needs improving. Shrinking the astronaut image and organizing / compressing / removing some of the information will help new users find what they need. The documentation already has a lot of information but what's missing is the user guide.

Possible sections and steps:

  1. Introduction
  2. What is the AAW
  3. How to create an account / gain access
  4. How to make a kubeflow notebook server, step by step.
  5. How to import / access your data
  6. Examples of what you can do in JupyterLab

A lot of the documentation will need adjustments and improvements.

bryanpaget commented 6 months ago

Notes: