Skip to content

Commit af57534

Browse files
committed
chore: adding docs
1 parent c12bafe commit af57534

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ This module automatically generates comprehensive documentation about your deplo
2525

2626
```bash
2727
# View documentation in terminal
28-
terraform output documentation
28+
terraform output -json meshplatform | jq -r '.documentation'
2929

3030
# Save documentation to markdown file
31-
terraform output -raw documentation > meshplatform-docs.md
31+
terraform output -json meshplatform | jq -r '.documentation' > meshplatform-docs.md
3232
```
3333

3434
The documentation includes:
@@ -76,12 +76,7 @@ The documentation includes:
7676
```sh
7777
# The JSON output contains sensitive values that must not be transmitted anywhere other then the platform config screen in meshStack.
7878
terraform output -json
79-
80-
# Get comprehensive documentation about your deployment
81-
terraform output documentation
82-
83-
# Save documentation to file
84-
terraform output -raw documentation > meshplatform-docs.md
79+
terraform output -json meshplatform
8580
```
8681
8782
### Using CLI

0 commit comments

Comments
 (0)