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

Document capabilities #35

Open
rplzzz opened this issue Nov 21, 2018 · 0 comments
Open

Document capabilities #35

rplzzz opened this issue Nov 21, 2018 · 0 comments

Comments

@rplzzz
Copy link
Contributor

rplzzz commented Nov 21, 2018

Each capability defined in the system is supposed to publish documentation that describes everything that other components will need to use the data (format, units, etc.) Right now most of that documentation exists only in our heads; before too long we will need to get this written down.

First we need to decide where we plan to capture this information. One possibility is to create a wiki for the repository. Another is to include some supplementary documentation that we will eventually publish on readthedocs.org. Whatever we do, we need to think about what happens if other groups adopt Cassandra for their models. How will they manage the documentation for their components' capabilities?

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