updating docs for endusers and contributors

rht-labs / api-design

NO LONGER ACTIVE - Home of our Swagger / OpenAPI Specifications, System Designs and Documentation

Apache License 2.0

4 stars 5 forks source link

updating docs for endusers and contributors #58

Closed sherl0cks closed 7 years ago

sherl0cks commented 7 years ago

What does this PR do?

Adds documentation for end users looking to write documents against the automation API
Adds documentation for contributors looking to extend the automation API

Is there a relevant Issue open for this?

Nope

Are there any other relevant resources that should be reviewed as well?

Nope

Who would you like to review this?

/cc @mtakane

mtakane commented 7 years ago

I feel that the Readme is very long and for easier maintenance of the information moving forward, we will want to split it into "what a inquisitive mind will want to know about PBI and this Repo" and "what an example for an end user will look like". The information found in the contributing and readme pages are good, but feel we will want to make the split.

@sherl0cks If not in this PR, can move this thought to be an issue for future completion.