Skip to content

Commit fcf7c14

Browse files
committed
docs(README): enhance documentation with detailed information
- add requirements section to specify terraform version - update outputs.tf link to github - update examples.tf link to github - update license link to github
1 parent 59a581f commit fcf7c14

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Terraform ArgoCD Module
2-
32
A Terraform module for creating and managing ArgoCD applications, projects, and repositories with support for multiple authentication methods and advanced configuration options.
43

54
***Note: This module is used to manage ArgoCD, not deploy ArgoCD***
@@ -14,12 +13,16 @@ A Terraform module for creating and managing ArgoCD applications, projects, and
1413
- **Enterprise Ready**: Support for GitHub Enterprise and advanced organizational features
1514

1615

16+
## Requirements
17+
18+
| Name | Version |
19+
|------|---------|
20+
| terraform | >= 1.12.2 |
1721

1822
## Providers
1923

2024
| Name | Version |
2125
|------|---------|
22-
| terraform | >= 1.12.2 |
2326
| [argoproj-labs/argocd](https://registry.terraform.io/providers/argoproj-labs/argocd/latest) | >= 7.10.0 |
2427

2528
## Authentication Types Supported
@@ -225,7 +228,7 @@ For a complete list of variables, see [variables.tf](./variables.tf).
225228
| `repository_connection_status` | Connection status of the repository |
226229
| `application_url` | Relative URL to view the application in ArgoCD UI |
227230

228-
For a complete list of outputs, see [outputs.tf](./outputs.tf).
231+
For a complete list of outputs, see [outputs.tf](https://github.com/v2d27/terraform-argocd-argocd/blob/main/outputs.tf).
229232

230233
## Security Considerations
231234

@@ -246,7 +249,7 @@ For a complete list of outputs, see [outputs.tf](./outputs.tf).
246249

247250
## Examples
248251

249-
See [examples.tf](./examples.tf) for comprehensive usage examples including:
252+
See [examples.tf](https://github.com/v2d27/terraform-argocd-argocd/blob/main/docs/examples/examples.tf) for comprehensive usage examples including:
250253
- SSH authentication setup
251254
- HTTPS with Personal Access Token
252255
- GitHub App authentication for enterprises
@@ -263,11 +266,11 @@ See [examples.tf](./examples.tf) for comprehensive usage examples including:
263266

264267
## License
265268

266-
This module is licensed under the Apache License 2.0. See [LICENSE](./LICENSE) for details.
269+
This module is licensed under the Apache License 2.0. See [LICENSE](https://github.com/v2d27/terraform-argocd-argocd?tab=Apache-2.0-1-ov-file) for details.
267270

268271
## Support
269272

270273
For issues and questions:
271-
1. Check the [examples](./examples.tf) for common patterns
274+
1. Check the [examples](https://github.com/v2d27/terraform-argocd-argocd/blob/main/docs/examples/examples.tf) for common patterns
272275
2. Review the ArgoCD documentation for provider-specific details
273276
3. Open an issue with detailed information about your use case

0 commit comments

Comments
 (0)