-
Notifications
You must be signed in to change notification settings - Fork 7
Open
Description
💡 TIP: Select the "Preview" Tab to help read these instructions.
1. Issue type
Type the letter "x" in the "checkbox" the best describe this issue.
- Feature: I'm requesting an enhancement.
- Other: I want to discuss something else.
2. User story summary
Describe what you want to accomplish and in what role/capacity, and why it's important to you.
EXAMPLE:
As a Job Applicant,
I want to submit my resume
In order to be considered for a job opening.
As a product maintainer,
I want to use GitHub as much as possible
In order to avoid relying on specs on hosted servers.
3. Acceptance criteria
Replace the examples below with your own imperative, "true/false" statements for the behavior you expect to see, or the behavior that would be true if there were no errors (for defects).
- 1. OpenAPI spec URLs point to GitHub raw YAML resources, e.g., https://raw.githubusercontent.com/commonality/archetypes/master/schemas/v1/quantities/quantities.yaml
- 2. All links in the repo point to raw.githubusercontent.com (including Swagger Validation badges)
- 3. All
ArchetypeAPI and SDK Documentation resources reside in the/docsdirectory - 4. All documents in the
/docsdirectory are published to commonality.github.io - 5. commonality.github.io resources leverage RunKit as much as possible.