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

Add documentation for library consumers #10

Open
3 of 4 tasks
patrislav opened this issue Nov 12, 2020 · 1 comment · Fixed by #16
Open
3 of 4 tasks

Add documentation for library consumers #10

patrislav opened this issue Nov 12, 2020 · 1 comment · Fixed by #16
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@patrislav
Copy link
Contributor

patrislav commented Nov 12, 2020

  • Improve and point to https://pkg.go.dev/ (once open-sourced)
  • Document AWS-specific info and current limitations:
    • EC2: only on-demand Linux instances with no pre-installed software are supported (e.g. no spot, reserved, Windows, SQL Server, etc.)
    • EC2: only the Compute and Storage costs are calculated (e.g. no GPU, monitoring, etc.)
    • document all the defaults and assumptions that are used in the calculations (e.g. for EC2: 730 hours in a month, for EBS: the "gp2" type, 8 GB storage, etc.) - this should include links to the appropriate provider docs
  • README and "how to contribute" guide
  • Add "how does it work" section, explaining the way the library interacts with the DB and the way cost is estimated
@patrislav
Copy link
Contributor Author

Reopening, not all the points were finished yet.

@patrislav patrislav reopened this Jan 25, 2021
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

Successfully merging a pull request may close this issue.

1 participant