-
Story
-
Resolution: Done
-
Normal
-
RHODS_1.1_GA
-
False
-
False
-
No
-
-
-
-
-
-
No
-
No
-
Yes
-
None
-
-
MODH Sprint 32
As a RHODS user, I need to know how to access and get started with a partner component.
*Getting Started*
Getting started are a s simple set of steps on how a customer gets access to Open Vino.. This needs to be in a markdown format document. Ideally, this should be a set of steps that links to the sign up process at a very high level.
Example items that would be helpful to cover:
How to use the package?
This will be a precursor to quickstart
Follow this example markdown document as a template.
*How-to's*
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:
*Quick Starts*
Quick starts guide the user to complete a task, most likely for the first time.
Example QuickStart yaml file: How do I launch a Jupyter Notebook (This quick start would walk you from the platform landing page through to creating your first notebook).
- is related to
-
RHODS-2052 Changes to Intel AiKit Quick Start
- Closed