Skip to content

Commit

Permalink
docs: deprecate share links
Browse files Browse the repository at this point in the history
  • Loading branch information
aliscott committed Nov 17, 2023
1 parent 67e1c02 commit fe105ec
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 35 deletions.
13 changes: 1 addition & 12 deletions docs/features/cli_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ If the above method does not work for your use-case, you can use Terraform to ge

## Combined output formats

The Infracost CLI can generate cost estimates in many formats: `json`, `diff`, `table`, `html`, `github-comment`, `gitlab-comment`, `azure-repos-comment`, `bitbucket-comment` and `slack-message`. To use them:
The Infracost CLI can generate cost estimates in many formats: `json`, `diff`, `table`, `github-comment`, `gitlab-comment`, `azure-repos-comment`, `bitbucket-comment` and `slack-message`. To use them:

1. Generate Infracost JSON output for each Terraform project and combine them into one file. This is the recommended way to store the snapshot of a cost estimate; it can be used by the CLI to generate other formats. The JSON format can also be used to setup [cost policies](/docs/features/cost_policies/).
```sh
Expand All @@ -155,15 +155,8 @@ The Infracost CLI can generate cost estimates in many formats: `json`, `diff`, `

# Diff output
infracost output --path infracost.json --format diff

# HTML output
infracost output --path infracost.json --format html --out-file report.html
```

Cost estimates can be shared with others including team members or management using either:
- The [share reports](/docs/features/share_links/) feature (recommended).
- Generating the HTML format, uploading it to object storage such as AWS S3. This format also includes the file names and Terraform tags from the files that were used to generate it.

Run `infracost output --help` to see other options, such as `--fields` and `--show-skipped`.

### Examples
Expand All @@ -172,7 +165,6 @@ Run `infracost output --help` to see other options, such as `--fields` and `--sh
defaultValue="json"
values={[
{label: 'JSON format', value: 'json'},
{label: 'HTML', value: 'html'},
{label: 'Table', value: 'table'},
{label: 'Diff', value: 'diff'},
{label: 'Pull request comment', value: 'pull-request-comment'},
Expand All @@ -193,9 +185,6 @@ Run `infracost output --help` to see other options, such as `--fields` and `--sh
cat infracost.json | jq -r '.diffTotalMonthlyCost'
```

</TabItem>
<TabItem value="html">
<img src={useBaseUrl("img/screenshots/html_report.png")} alt="Infracost HTML report" />
</TabItem>
<TabItem value="table">

Expand Down
22 changes: 0 additions & 22 deletions docs/features/share_links.md

This file was deleted.

1 change: 0 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ module.exports = {
'features/usage_based_resources',
'features/terraform_modules',
'features/terragrunt',
'features/share_links',
'features/environment_variables',
],
},
Expand Down

0 comments on commit fe105ec

Please sign in to comment.