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

Write Wiki Documentation #13

Open
erwang01 opened this issue Jan 14, 2021 · 2 comments
Open

Write Wiki Documentation #13

erwang01 opened this issue Jan 14, 2021 · 2 comments

Comments

@erwang01
Copy link
Contributor

Go through the existing code in the operator branch write documentation for the Wiki.

Mainly we care about the API calls and what they do.

Be careful to not extrapolate what our code does. If our code doesn't do something it should do, either open a github issue for it or say in the wiki that it doesn't do xyz.

This is gonna be an overhaul of our specs from here: https://docs.google.com/document/d/1g3dKYSgtFYrp6Fd4SA6JV8K353C8m3OqXH_cyjhj9-0/edit
and https://docs.google.com/document/d/16jO-q_J6VPLoWYZGIHMzHoWHSoP7eIxv-Z6Rr-1b4Ko/edit

We are trying to assess how much of our code base actually conforms to the spec sheet along with providing a well written wiki so we can lose the google doc.

@erwang01
Copy link
Contributor Author

erwang01 commented Feb 5, 2021

Service call API wiki update as well. Notably we added IDs to some of the responses.

@erwang01
Copy link
Contributor Author

erwang01 commented May 1, 2021

Ya this is outdated but the wiki still needs to be written with the new info...

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

1 participant