Uploaded image for project: 'Red Hat OpenShift Data Science'
  1. Red Hat OpenShift Data Science
  2. RHODS-143

4.7. Documentation for MODH and all services

XMLWordPrintable

    • Documentation for MODH and all services
    • False
    • False
    • No
    • To Do
    • 0% To Do, 0% In Progress, 100% Done
    • Undefined
    • No

      We plan for MODH users to have access to many different services. Some services may already be installed while others are available to purchase. For installed services, MODH needs to provide sufficient documentation to enable users to start using and getting value from the services. For the available (not yet installed) services, users to be able to learn about the service and why it's valuable. Users also need to be able to access general MODH documentation on topic such as getting access to data so they can get value from the service. 

      Requirements:

      1. P0: The system must provide tutorials and documentation to help users get started with the overall MODH service. 
      2. P0: The system must provide startup/tutorial documentation on how to access data for use in Notebooks. For example, users might need to access data in S3. 
      3. P0: For each installed service in MODH, the system must provide tutorials/getting started documentation to help users get started using the service.
      4. P1: The system must provide the ability to search documentation, so users can find information to answer questions or learn more about topics of interest.
      5. P0: For each available but not installed service, the system must provide documentation to help users learn about the value of the service and how it can be used to address data science needs & use cases. 

       

      Considerations/questions:

      • Need to ensure users can find answers to specific questions (eg. how do I access & use data in S3). If documentation access is limited to specific services in MODH, users may not know where to look.
      • Need to ensure sufficient documentation from 3rd party partners.

            Unassigned Unassigned
            jdemoss@redhat.com Jeff DeMoss
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: