Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Need a "Help" page with content #148

Open
horsburgh opened this issue May 14, 2024 · 0 comments
Open

Need a "Help" page with content #148

horsburgh opened this issue May 14, 2024 · 0 comments
Assignees

Comments

@horsburgh
Copy link
Contributor

horsburgh commented May 14, 2024

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

@horsburgh horsburgh added this to the July 2024 Catalog Release milestone May 28, 2024
@Maurier Maurier self-assigned this Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants