Additional tutorials

[alexandercyu]

Tutorial topics outside of how to use the platform for data analysis

Users:

• Getting Started

  • Creating Account
  • Account management (change password, change user details)
  • Logging in
  • Navigating interface (browser login page, node page, etc.)
  • Main areas of site/platform (catalog, jupyter)

• Jupyter

  • Getting Started
  • Version Control (Include how to use Git with JupyterLab?)
  • How to use (import data / use data, do work, save work, import work, export work)
  • Troubleshooting

• Weaver

  • Getting Started
  • How to build workflows (how to access workflows outside of university computing environment)

• STAC Catalog

  • Getting Started
  • How to use (search, etc.)
  • How to search datasets
  • How to search services

• Python client

  • Getting Started

• Nodes/Services

  • How to find
  • How to log in
  • How to use node resources
  • Troubleshooting

Admin:

• Getting Started
  • Installing requirements?
  • Installing node
  • Node management
  • Admin Account management
  • User Account management

• Services

• Services Management

• Data Management

• Troubleshooting

  • Services
  • Accounts
  • Data

[mishaschwartz]

Initial division of work:

• @alexandercyu : Users: getting started
• @dchandan : Users: Stac catalog and python client
• @mishaschwartz : Admin : getting started

[mishaschwartz]

General format for book pages:

• h1 title
• short sentence/paragraph describing purpose of page
• whatever other page content below

[mishaschwartz]

How to write a good tutorial:

• Do not assume the reader has any prior knowledge of what you are describing
• If you do not want to have to describe everything from the ground up, provide links to other places where they can get the required background knowledge
• Start every new section with a brief description of what that section covers, then go into detail.
• If a section is starting to get too long, move it to its own page
• Do not assume a specific node configuration (ie. UofT or PAVICS, etc.). If a tutorial only applies for a specific configuration (e.g. jupyterhub is installed) state that assumption explicitly at the very beginning

[dchandan]

I think we should add a "Network architecture" page where we discuss the node-management software and its components, and how various "network" specific aspects of the platform are implemented. It would certainly be useful to Admins, but I do see a value for it for "Advanced users". We can discuss about this.

[dchandan]

Proposal for a "Getting Support" page.