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

README: Write user guide #111

Open
pathob opened this issue Dec 9, 2021 · 2 comments
Open

README: Write user guide #111

pathob opened this issue Dec 9, 2021 · 2 comments
Assignees

Comments

@pathob
Copy link
Member

pathob commented Dec 9, 2021

The confapi-commons' README.md should be used as a central documentation where we describe what ConfAPI is, how it can be used and how the plugins' index.adoc can be read.

This guide should give an example with an endpoint existing in all plugins (should be /settings), how to get data, how to set data and also explain how the API behaves with unset attributes in the JSON objects

@xHighroad
Copy link

Done. Waiting for review.

@pathob
Copy link
Member Author

pathob commented Jan 11, 2022

@xHighroad, this task is not done.

  • There is no pull request
  • There is a branch in the commons project with two commits that don't belong together
  • It doesn't look like you checked the resulting formatting of the Markdown you wrote

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