As a user of RHODS, it is helpful to have the steps outlined for the common set of tasks for each component.

The goal of how-to’s is to tell users how to complete small tasks specific to one tool or technology in the platform. These will be composed of numbered steps and take <5 minutes to complete.

Example:
Q: How do I connect to my data in s3 through a Jupyter Notebook?
A: 1. You will need to know your s3 credentials.
2. Visit the Jupyterhub spawner page. Under ‘environment variables’ click ‘add’.
3. In the ‘name’ box, type ‘S3_KEY’
4. In the ‘value’ box’ paste your s3 key
5. Click ‘launch’ to launch a jupyter notebook server. Your s3_key can now be accessed as an environment variable in Python.

The how-to's must be created in the following yaml format for each how-to card:

metadata:
  name: 
  type: how-to
spec:
  appName:
  displayName: 
  description: 
  durationMinutes: