Skip to content

Add poetry dependency management #25

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ This is the repository backing the site hosted at [handbook.vantage.sh](http://h

The Cloud Cost Handbook is a free, open-source, community-supported set of guides meant to help explain often-times complex pricing of public cloud infrastructure and service providers in "plain english". This guide is is open for anyone to contribute their knowledge to the community. [Vantage](http://vantage.sh/) employees will maintain hosting the guide for everyone and ensure that content is relevant and adheres to styleguides.

The Cloud Cost Handbook is organized into two sections: general concepts and per-service pages.
The Cloud Cost Handbook is organized into two sections: general concepts and per-service pages.

* **General concepts** are meant to cover topics which apply across multiple different infrastructure service.
* **Per-service pages** are meant to give a brief summary of the service, the pricing dimensions of the service and optionally a list of cost concepts as it relates to that service.
* **General concepts** are meant to cover topics which apply across multiple different infrastructure service.
* **Per-service pages** are meant to give a brief summary of the service, the pricing dimensions of the service and optionally a list of cost concepts as it relates to that service.

## Contributing Guidelines

Issues and pull requests are welcome for requesting or contributing content. Vantage employees will review all issues and PRs to ensure we're keeping content relevant and up to standard. You're welcome to get in contact with us on our [Slack Community](https://join.slack.com/t/vantagecommunity/shared_invite/zt-oey52myv-gq4AWRKkX25kjp1UGziPTw) as well where we have a devoted #cloud-cost-handbook channel for discussion as it relates to the handbook.
Issues and pull requests are welcome for requesting or contributing content. Vantage employees will review all issues and PRs to ensure we're keeping content relevant and up to standard. You're welcome to get in contact with us on our [Slack Community](https://join.slack.com/t/vantagecommunity/shared_invite/zt-oey52myv-gq4AWRKkX25kjp1UGziPTw) as well where we have a devoted #cloud-cost-handbook channel for discussion as it relates to the handbook.

This site leverages [mkdocs](https://www.mkdocs.org/). Prior to opening a pull request, please review your changes locally by running `mkdocs serve` which will allow you to access and review your changes locally at `http://localhost:8000/`.
This site leverages [mkdocs](https://www.mkdocs.org/). Prior to opening a pull request, please review your changes locally by installing the dependencies via [poetry](https://python-poetry.org) and then running `poetry run mkdocs serve` which will allow you to access and review your changes locally at `http://localhost:8000/`.

## Keep Up To Date

Feel free to watch/star this repo as we're looking to update the site regularly with additional services and concepts. Vantage also works on the following relevant projects:

* [EC2Instances.info](https://github.com/vantage-sh/ec2instances.info) - An open-source tool for comparing EC2 instance prices and configurations.
* [The AWS Cost Leaderboard](https://leaderboard.vantage.sh/) - A hosted site of the top AWS cost centers.
* [Vantage](https://vantage.sh/) - A cloud cost transparency platform.
* [EC2Instances.info](https://github.com/vantage-sh/ec2instances.info) - An open-source tool for comparing EC2 instance prices and configurations.
* [The AWS Cost Leaderboard](https://leaderboard.vantage.sh/) - A hosted site of the top AWS cost centers.
* [Vantage](https://vantage.sh/) - A cloud cost transparency platform.
Loading