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

Reorganize developer specs #47

Open
TimEvens opened this issue Jul 10, 2017 · 0 comments
Open

Reorganize developer specs #47

TimEvens opened this issue Jul 10, 2017 · 0 comments

Comments

@TimEvens
Copy link
Contributor

TimEvens commented Jul 10, 2017

Currently developer schemas/specs are in two places, docs and on the main page under Developer integration. This should be reorganized so that they are in the same place, such as under developer section. The developer section should have:

  1. API Documentation (e.g. Message Bus API, MariaDB Schema, and REST API). API documentation SHOULD contain examples as well, so each API might be a section by itself. For example, develop/api/msgbus, develop/api/topomgr, develop/api/db
  2. Guides This section would include details of how a developer starts to develop and the options they have. Such as when to use live Kafka verses DB verses Topology Manager.
  3. API Bindings - This is a summary page for bindings available. Links should reference the API documentation sections.

API documentation does not document the architecture or component itself. That's documented under component. Each API section should reference the component documentation for easy navigation between them.

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