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

docs(api-specs): revisions #17

Open
2 of 7 tasks
gregswindle opened this issue Sep 5, 2017 · 1 comment
Open
2 of 7 tasks

docs(api-specs): revisions #17

gregswindle opened this issue Sep 5, 2017 · 1 comment

Comments

@gregswindle
Copy link
Contributor

gregswindle commented Sep 5, 2017

💡 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 Archetype API and SDK Documentation resources reside in the /docs directory
  • 4. All documents in the /docs directory are published to commonality.github.io
  • 5. commonality.github.io resources leverage RunKit as much as possible.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant