Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/l-with/terraform-module-gitlab-doc
https://github.com/l-with/terraform-module-gitlab-doc
documentation gitlab terraform terraform-module
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/l-with/terraform-module-gitlab-doc
- Owner: l-with
- Created: 2022-09-15T17:03:51.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-24T17:26:22.000Z (12 months ago)
- Last Synced: 2024-04-17T21:18:56.657Z (7 months ago)
- Topics: documentation, gitlab, terraform, terraform-module
- Language: HCL
- Homepage:
- Size: 24.4 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# terraform-module-gitlab-doc
Terraform module which generates documentation for [GitLab](https://gitlab.com).
The documentation is generated as HTML.
## Terraform
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | >= 0.15 |
| [gitlab](#requirement\_gitlab) | >= 3.18 |## Providers
| Name | Version |
|------|---------|
| [gitlab](#provider\_gitlab) | >= 3.18 |## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [gitlab_groups.groups](https://registry.terraform.io/providers/gitlabhq/gitlab/latest/docs/data-sources/groups) | data source |
| [gitlab_project_membership.project_membership](https://registry.terraform.io/providers/gitlabhq/gitlab/latest/docs/data-sources/project_membership) | data source |
| [gitlab_projects.projects](https://registry.terraform.io/providers/gitlabhq/gitlab/latest/docs/data-sources/projects) | data source |
| [gitlab_users.users](https://registry.terraform.io/providers/gitlabhq/gitlab/latest/docs/data-sources/users) | data source |## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [gitlab\_api\_v4\_path](#input\_gitlab\_api\_v4\_path) | the path for the GitLab api | `string` | `"/api/v4/"` | no |
| [gitlab\_token](#input\_gitlab\_token) | the token for the terraform-provider-gitlab | `string` | n/a | yes |
| [gitlab\_url](#input\_gitlab\_url) | the gitlab url | `string` | n/a | yes |
| [groups\_sort](#input\_groups\_sort) | the value for sort for full\_path | `string` | `"asc"` | no |
| [html\_font\_family](#input\_html\_font\_family) | the font family for html | `string` | `"sans-serif"` | no |
| [projects\_sort](#input\_projects\_sort) | the value for sort for name\_with\_namespace | `string` | `"asc"` | no |
| [tabulator\_theme](#input\_tabulator\_theme) | the tabulator theme | `string` | `"semantic-ui"` | no |
| [template\_files\_path](#input\_template\_files\_path) | the path of the template files | `string` | `"templates"` | no |
| [template\_type](#input\_template\_type) | the template type selecting the template subfolder (only 'tabulator' by now) | `string` | `"tabulator"` | no |
| [users\_order\_by](#input\_users\_order\_by) | the value for order\_by in resource gitlab\_users | `string` | `"name"` | no |
| [users\_sort](#input\_users\_sort) | the value for sort in resource gitlab\_users | `string` | `"asc"` | no |## Outputs
| Name | Description |
|------|-------------|
| [groups\_html](#output\_groups\_html) | n/a |
| [projects\_html](#output\_projects\_html) | n/a |
| [users\_html](#output\_users\_html) | n/a |