Skip to content

Commit 6987202

Browse files
committed
chore: update documentation format
1 parent 9941680 commit 6987202

File tree

2 files changed

+31
-27
lines changed

2 files changed

+31
-27
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ _Security related notice: Versions 4.7.0, 4.8.0, 4.9.0 and 4.9.1 of the Terrafor
3131
- [Projects Configuration](#projects-configuration)
3232
- [Webhooks Configuration](#webhooks-configuration)
3333
- [Secrets Configuration](#secrets-configuration)
34-
- [Autolink References](#autolink-references-configuration)
34+
- [Autolink References Configuration](#autolink-references-configuration)
3535
- [Module Configuration](#module-configuration)
3636
- [Module Outputs](#module-outputs)
3737
- [External Documentation](#external-documentation)
@@ -834,22 +834,24 @@ This is due to some terraform limitation and we will update the module once terr
834834

835835
#### Autolink References Configuration
836836

837-
- [**`autolink_references`**](#var-autolink-references): *(Optional `list(autolink_references)`)*<a name="var-autolink-references"></a>
837+
- [**`autolink_references`**](#var-autolink_references): *(Optional `list(autolink_reference)`)*<a name="var-autolink_references"></a>
838838

839-
This resource allows you to create and manage autolink references for GitHub repository.
839+
This resource allows you to create and manage autolink references for GitHub repository.
840840

841841
Default is `[]`.
842842

843843
Each `autolink_reference` object in the list accepts the following attributes:
844844

845-
- [**`key_prefix`**](#attr-autolink-references-key_prefix): *(**Required** `string`)*<a name="attr-autolink-references-key_prefix"></a>
845+
- [**`key_prefix`**](#attr-autolink_references-key_prefix): *(**Required** `string`)*<a name="attr-autolink_references-key_prefix"></a>
846846

847-
The prefix of the autolink reference.
847+
The key prefix of the autolink reference.
848848

849-
- [**`target_url_template`**](#attr-autolink-references-target_url_template): *(**Required** `string`)*<a name="attr-autolink-references-target_url_template"></a>
849+
- [**`target_url_template`**](#attr-autolink_references-target_url_template): *(Optional `string`)*<a name="attr-autolink_references-target_url_template"></a>
850850

851851
The target url template of the autolink reference.
852852

853+
Default is `""`.
854+
853855
### Module Configuration
854856

855857
- [**`module_depends_on`**](#var-module_depends_on): *(Optional `list(any)`)*<a name="var-module_depends_on"></a>
@@ -930,6 +932,7 @@ The following attributes are exported by the module:
930932
- https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_collaborator
931933
- https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_deploy_key
932934
- https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_project
935+
- https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository_autolink_reference
933936

934937
## Module Versioning
935938

@@ -989,6 +992,7 @@ Copyright &copy; 2020-2022 [Mineiros GmbH][homepage]
989992
[`github_repository_collaborator`]: https://www.terraform.io/docs/providers/github/r/repository_collaborator.html#attribute-reference
990993
[`github_repository_deploy_key`]: https://www.terraform.io/docs/providers/github/r/repository_deploy_key.html#attributes-reference
991994
[`github_repository_project`]: https://www.terraform.io/docs/providers/github/r/repository_project.html#attributes-reference
995+
[`github_repository_autolink_reference`]: https://www.terraform.io/docs/providers/github/r/repository_autolink_reference.html#attributes-reference
992996
[homepage]: https://mineiros.io/?ref=terraform-github-repository
993997
[hello@mineiros.io]: mailto:hello@mineiros.io
994998
[badge-build]: https://github.com/mineiros-io/terraform-github-repository/workflows/CI/CD%20Pipeline/badge.svg

README.tfdoc.hcl

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1081,32 +1081,32 @@ section {
10811081
END
10821082
}
10831083
}
1084-
}
1085-
1086-
section {
1087-
title = "Autolink References Configuration"
10881084

1089-
variable "autolink_references" {
1090-
type = list(autolink_reference)
1091-
default = []
1092-
description = <<-END
1093-
This resource allows you to create and manage autolink references for GitHub repository.
1094-
END
1085+
section {
1086+
title = "Autolink References Configuration"
10951087

1096-
attribute "key_prefix" {
1097-
required = true
1098-
type = string
1088+
variable "autolink_references" {
1089+
type = list(autolink_reference)
1090+
default = []
10991091
description = <<-END
1100-
The key prefix of the autolink reference.
1092+
This resource allows you to create and manage autolink references for GitHub repository.
11011093
END
1102-
}
11031094

1104-
attribute "target_url_template" {
1105-
type = string
1106-
default = ""
1107-
description = <<-END
1108-
The target url template of the autolink reference.
1109-
END
1095+
attribute "key_prefix" {
1096+
required = true
1097+
type = string
1098+
description = <<-END
1099+
The key prefix of the autolink reference.
1100+
END
1101+
}
1102+
1103+
attribute "target_url_template" {
1104+
type = string
1105+
default = ""
1106+
description = <<-END
1107+
The target url template of the autolink reference.
1108+
END
1109+
}
11101110
}
11111111
}
11121112
}

0 commit comments

Comments
 (0)