You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: README.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,4 @@
1
1
# Terraform ArgoCD Module
2
-
3
2
A Terraform module for creating and managing ArgoCD applications, projects, and repositories with support for multiple authentication methods and advanced configuration options.
4
3
5
4
***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
14
13
-**Enterprise Ready**: Support for GitHub Enterprise and advanced organizational features
@@ -225,7 +228,7 @@ For a complete list of variables, see [variables.tf](./variables.tf).
225
228
|`repository_connection_status`| Connection status of the repository |
226
229
|`application_url`| Relative URL to view the application in ArgoCD UI |
227
230
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).
229
232
230
233
## Security Considerations
231
234
@@ -246,7 +249,7 @@ For a complete list of outputs, see [outputs.tf](./outputs.tf).
246
249
247
250
## Examples
248
251
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:
250
253
- SSH authentication setup
251
254
- HTTPS with Personal Access Token
252
255
- GitHub App authentication for enterprises
@@ -263,11 +266,11 @@ See [examples.tf](./examples.tf) for comprehensive usage examples including:
263
266
264
267
## License
265
268
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.
267
270
268
271
## Support
269
272
270
273
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
272
275
2. Review the ArgoCD documentation for provider-specific details
273
276
3. Open an issue with detailed information about your use case
0 commit comments