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

Implement code documentation #20

Open
Cmdrd opened this issue Jan 27, 2020 · 2 comments
Open

Implement code documentation #20

Cmdrd opened this issue Jan 27, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@Cmdrd
Copy link
Contributor

Cmdrd commented Jan 27, 2020

While the code base is relatively small, it has taken some time to get up to speed with the functionality, especially with not being as familiar with the provided Prometheus Python library metric functions.

Putting this issue in as a working thread for further documentation discussions.

Currently have a local branch for adding documentation but definitely throw suggestions in here. Will get a PR done for an initial evaluation.

@Cmdrd
Copy link
Contributor Author

Cmdrd commented Jan 28, 2020

Also might be a good idea to document the metrics that are being returned, either in the README or somewhere else so that it is easier for someone to find what metrics they are looking for. A separate issue could be created for implementing that if there is interest in something like that.

@anclrii anclrii added the documentation Improvements or additions to documentation label May 31, 2020
@GollyTicker
Copy link
Contributor

Having some basic documentation regarding the test and docker build process would also be good. (See #72). What do you think?

Otherwise people need to reverse-engineer it from the github workflow - and some may not be knowledgeable enough to look there in the first place...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants