Skip to content

Checklist for first release of User Docs #14

@LAShemilt

Description

@LAShemilt

This is a check list of things that we want the documentation to include as a first release:

Website

User Documentation

Operator Documentation

  • Datasets Ingestion Guide
    • Curl
    • python SDK
    • pyscicat
  • Attachments
  • Datablocks
  • Jobs workflow add jobs workflow for user-guide #6
  • Frontend Configuration
    • Edit Keywords Button
  • Authorization Model Docs add authorization model for operators #7
  • Description of all fields
  • OIDC integration - make more prominent
  • Troubleshooting Guide
  • Proposal Ingestion
  • Sample Ingestion
  • Link out to developer's guide for endpoint description in Backend Swagger page
  • list of features
  • how to implement features

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions