Skip to content

Commit 95a7e00

Browse files
committed
chore: adding docs part in readme
1 parent d10066c commit 95a7e00

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,24 @@ To run this module, you need the following:
1919
2. Privileged Role Administrator AND (Cloud) Application Administrator
2020
- Permissions on Azure Resource Level: User Access Administrator on the Management Group that should be managed by meshStack
2121

22+
## Documentation
23+
24+
This module automatically generates comprehensive documentation about your deployment. After running `terraform apply`, you can view detailed information about your configuration:
25+
26+
```bash
27+
# View documentation in terminal
28+
terraform output documentation
29+
30+
# Save documentation to markdown file
31+
terraform output -raw documentation > meshplatform-docs.md
32+
```
33+
34+
The documentation includes:
35+
- Service principal deployment status and IDs
36+
- Configuration details and scopes
37+
- meshStack integration information
38+
- Available terraform commands for your specific setup
39+
2240
## How to Use This Module
2341

2442
### Using Azure Portal
@@ -58,6 +76,12 @@ To run this module, you need the following:
5876
```sh
5977
# The JSON output contains sensitive values that must not be transmitted anywhere other then the platform config screen in meshStack.
6078
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
6185
```
6286
6387
### Using CLI

0 commit comments

Comments
 (0)