Skip to content

Need a "Help" page with content #148

@horsburgh

Description

@horsburgh

In the functional specifications document, we describe the following that could be handled on a Help page:

  1. Provide guidance for accessing data within the catalog. This guidance should cover a range of topics and references/links to instructional resources to assist with data access whenever possible (e.g., documentation).
  2. The catalog should leverage a self-documenting software pattern (e.g., OpenAPI/Swagger) to document API use - the help page should briefly describe the API and provide a link to the API documentation.
  3. A clear and concise description of the resource registration process either on the resource registration page or on a “Help” page, including any instructions, guidelines, or requirements that users need to follow.

This page should reference the documentation started in #108

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions