Skip to content

Feature/docs output #60

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

Closed
wants to merge 2 commits into from
Closed

Feature/docs output #60

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
106a317
chore: adding better infos in Readme about the docs
florianow Aug 20, 2025
d441a21
Merge branch 'main' into feature/docs-output
florianow Aug 20, 2025
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
11 changes: 3 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ This module automatically generates comprehensive documentation about your deplo

```bash
# View documentation in terminal
terraform output documentation
terraform output -json meshplatform | jq -r '.documentation'

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

The documentation includes:
Expand Down Expand Up @@ -76,12 +76,7 @@ The documentation includes:
```sh
# The JSON output contains sensitive values that must not be transmitted anywhere other then the platform config screen in meshStack.
terraform output -json

# Get comprehensive documentation about your deployment
terraform output documentation

# Save documentation to file
terraform output -raw documentation > meshplatform-docs.md
terraform output -json meshplatform
```

### Using CLI
Expand Down
Loading