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.

Sign up for GitHub

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

docs: spelling & grammar tweaks #689

Merged
merged 1 commit into from
Jan 7, 2025
Merged

docs: spelling & grammar tweaks #689

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/features/usage_based_resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ The wildcard character `[*]` can be used for resource arrays (resources with [`c

#### EC2 reserved instances

What-if anlaysis can be done on AWS EC2 Reserved Instances (RI) using the usage file. The RI type, term and payment option can be defined as shown below, to quickly get a monthly cost estimate. This works with `aws_instance` as well as `aws_eks_node_group` and `aws_autoscaling_group` as they also create EC2 instances. Let us know how you'd like Infracost to show the upfront costs by [creating a GitHub issue](https://github.com/infracost/infracost/issues/).
What-if analysis can be done on AWS EC2 Reserved Instances (RI) using the usage file. The RI type, term and payment option can be defined as shown below, to quickly get a monthly cost estimate. This works with `aws_instance` as well as `aws_eks_node_group` and `aws_autoscaling_group` as they also create EC2 instances. Let us know how you'd like Infracost to show the upfront costs by [creating a GitHub issue](https://github.com/infracost/infracost/issues/).

```yml
version: 0.1
Expand Down
12 changes: 6 additions & 6 deletions docs/supported_resources/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ title: Overview

Infracost supports over **1,100** Terraform resources across [AWS](/docs/supported_resources/aws), [Azure](/docs/supported_resources/azure) and [Google](/docs/supported_resources/google). That number is growing fast thanks to our [large open source community](https://github.com/infracost/infracost/#community-and-contributing) of contributors.

The quickest way to find out if your Terraform resources are supported is to run [`infracost breakdown`](/#usage) with the `--show-skipped` flag. This shows the unsupported resources at the bottom of the output
The quickest way to find out if your Terraform resources are supported is to run [`infracost breakdown`](/#usage) with the `--show-skipped` flag. This shows the unsupported resources at the bottom of the output.

You could also run the following command to only see the unsupported resources:
You can also run the following command to see only the unsupported resources:
`infracost breakdown --path . --format=json | jq ".summary.unsupportedResourceCounts"`

### The resource I want isn't supported

We regularly add support for new resources so we recommend watching our repo for releases: goto the [repo](https://github.com/infracost/infracost) page, click on the Watch button > select Custom > Releases and click on Apply.
We regularly add support for new resources so we recommend watching our repo for releases: Go to the [repo](https://github.com/infracost/infracost) page, click on the Watch button > select Custom > Releases and click on Apply.

You can help by:
1. [Creating an issue](https://github.com/infracost/infracost/issues/new/choose) and mentioning the resource names you need; we'll try to prioritize it depending on the community feedback.
1. [Creating an issue](https://github.com/infracost/infracost/issues/new/choose) and mentioning the resource names you need; we'll try to prioritize it depending on community feedback.
2. [Contributing to Infracost](https://github.com/infracost/infracost#contributing). You can join our [community Slack channel](https://www.infracost.io/community-chat) if you need help contributing.

We plan to add support for other IaC tools such as [Pulumi](https://github.com/infracost/infracost/issues/187), [AWS CloudFormation/CDK](https://github.com/infracost/infracost/issues/190) and [Azure ARM/Bicep](https://github.com/infracost/infracost/issues/812). Please 👍 them if you'd like us to work on them sooner.
We plan to add support for other IaC tools such as [Pulumi](https://github.com/infracost/infracost/issues/187), [AWS CloudFormation/CDK](https://github.com/infracost/infracost/issues/190), and [Azure ARM/Bicep](https://github.com/infracost/infracost/issues/812). Please 👍 them if you'd like us to work on them sooner.

### My cost estimate looks wrong

Please [create an issue](https://github.com/infracost/infracost/issues/new/choose) and provide the Terraform resource code that can be used to reproduce the issue. If possible, also include any relevant billing data from the cloud vendor that might help us troubleshoot.
Please [create an issue](https://github.com/infracost/infracost/issues/new/choose) and provide the Terraform resource code that can be used to reproduce the issue. If possible, please also include any relevant billing data from the cloud vendor that might help us troubleshoot.
2 changes: 1 addition & 1 deletion docs/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Try the following troubleshooting steps and join our [community Slack channel](h

If Infracost is **erroring or running too slow**, email us at [[email protected]](mailto:[email protected]) so we can arrange a debugging session with you quickly.

If your pull requests comments are being posted but they are **not showing in the dashboard**, ensure that the:
If your pull request comments are being posted but they are **not showing in the dashboard**, ensure that the:
1. In Infracost Cloud's Org settings page, the cost estimate dashboard is enabled.
2. Infracost CLI version (`infracost --version`) being used is latest patch version of v0.10.
3. [Required environment variables](/docs/features/environment_variables/#environment-variables-to-set-metadata) are set before the `infracost breakdown` and `infracost diff` commands are run. You can verify this by running `cat infracost.json | jq .metadata` or `infracost breakdown --path /code --format json | jq .metadata` and checking the Infracost JSON block shows your pull request metadata.
Expand Down
Loading