-
Notifications
You must be signed in to change notification settings - Fork 24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
documentation: generate docs from provider schemas #248
Merged
+57,560
−2,075
Merged
Changes from all commits
Commits
Show all changes
68 commits
Select commit
Hold shift + click to select a range
ef11703
tooling: vendor tfplugindocs to generate documentation from code
sauterp b76d94c
generate doc for deprecated anti-affinity group
sauterp be0d93e
generate sks clusters documentation with a custom template
sauterp 4c9d401
generate deprecated compute instance doc
sauterp 837a628
generate ssh_key docs
sauterp 2194613
generate docs for iam access keys
sauterp 4d8a2ec
generate docs for elastic ip resource
sauterp 504cd94
generate doc for ssh_keypair rsource
sauterp a9584fa
generate docs for sks nodepools
sauterp 5ee1638
generate docs for sks kubeconfig resource
sauterp 7456c5d
generate doc for security group rules resource
sauterp d8a4c01
generated doc for security_group_rule resource
sauterp 606267a
generate doc for security_group resource
sauterp 066e373
generate doc for secondary_ipaddress resource
sauterp 966f768
generate doc for private networks
sauterp 563ed88
generate doc for nlb_service resource
sauterp 4b0a9ad
generate doc for nlb resource
sauterp afc654c
generate doc for nic resource
sauterp 020c54d
generate doc for deprecated network resource
sauterp 461fe76
generate doc deprecated ipaddress resource
sauterp 12a268a
generate doc for instance_pool resource
sauterp 55defe3
generate doc for domain_record resource
sauterp 01c9398
generate doc for domain resource
sauterp f71f6b0
generate doc for database resource
sauterp 0b833f5
generate doc for compute_instance resource
sauterp a93bc39
generate doc for anti_affinity_group resource
sauterp 70cc8f0
generate doc for deprecated affinity resource
sauterp 68e9844
generate doc for the provider
sauterp 569d9c3
move guides to the templates directory so they are copied to docs folder
sauterp 711fd62
generate doc for template data source
sauterp 6cee32a
generate doc for security_group data source
sauterp 9865aa6
generate doc for private_network data source
sauterp e29ce5e
add template for data sources
sauterp 7730cf9
generate doc for nlb data source
sauterp 4f4c855
generate doc for deprecated network data source
sauterp 828b5f8
generate doc for instance_pool_list data source
sauterp deede68
generate doc for instance_pool data source
sauterp 3744375
generate doc for elastic_ip data source
sauterp 7d428c6
generate doc for domain_record data source
sauterp a52f876
generate doc for domain data source
sauterp c49e5f5
generate doc for deprecated compute_template data source
sauterp 6e654d4
generate doc for deprecated compute_ipaddress data source
sauterp 8c1fbca
generate doc for compute_instance_list data source
sauterp 9aa2c8a
generate doc for compute_instance data source
sauterp 645cdf6
generate doc for deprecated compute data source
sauterp a412f79
generate doc for anti_affinity_group data source
sauterp ae34a9c
generate doc for deprecated affinity data source
sauterp 44fc21e
add warnings for attributes where ForceNew == true
sauterp 27f1faf
complete the ForceNew warning message in docs
sauterp 2fe3162
add script and step to CI to check that the documentation is up to date
sauterp f34891a
test commit to verify that the CI step fails if the documentation
sauterp 32b3758
show offending files in check-documentation-clean.sh output
sauterp aad0fbe
Revert "test commit to verify that the CI step fails if the documenta…
sauterp b1912ce
remove mistaken Deprecation subcategory from sks_kubeconfig resource
sauterp 2f36528
update database docs after rebase
sauterp 1662480
remove $ prefix from shell examples which don't have an output below
sauterp bb0d5eb
remove all $ in shell examples
sauterp ba4da7f
fix acc test
sauterp cdad37d
reintroduce accidentally deleted code
sauterp e18e23b
Revert "reintroduce accidentally deleted code"
sauterp c1dc61b
fix the broken example in intex.md
sauterp 76ea6fd
run doc check in parallel job
sauterp 4824dd6
fix action
sauterp 82c457b
fix action
sauterp a92323c
fix action
sauterp bdbcdd2
provider page title to uppercase
sauterp 8dd5e38
fix acc test
sauterp dfce7b7
fix acc test
sauterp File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
name: "Shared setup steps" | ||
runs: | ||
using: "composite" | ||
steps: | ||
- uses: actions/setup-go@v2 | ||
with: | ||
go-version: '~1.18' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,22 @@ | ||
--- | ||
page_title: "Exoscale: exoscale_affinity" | ||
subcategory: "Deprecated" | ||
description: |- | ||
page_title: "exoscale_affinity Data Source - terraform-provider-exoscale" | ||
subcategory: "Deprecated | ||
"description: |- | ||
Fetch Exoscale Anti-Affinity Groups data. | ||
--- | ||
|
||
# exoscale\_affinity | ||
# exoscale_affinity (Data Source) | ||
|
||
!> **WARNING:** This data source is DEPRECATED and will be removed in the next major version. Please use [exoscale_anti_affinity_group](./anti_affinity_group.md) instead. | ||
|
||
|
||
## Arguments Reference | ||
|
||
* `id` - The anti-affinity group ID to match (conflicts with `name`) | ||
* `name` - The group name to match (conflicts with `id`) | ||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Optional | ||
|
||
## Attributes Reference | ||
- `id` (String) The anti-affinity group ID to match (conflicts with `name`) | ||
- `name` (String) The group name to match (conflicts with `id`) | ||
|
||
In addition to the arguments listed above, the following attributes are exported: | ||
|
||
* n/a |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,37 @@ | ||
--- | ||
page_title: "Exoscale: exoscale_compute" | ||
page_title: "exoscale_compute Data Source - terraform-provider-exoscale" | ||
subcategory: "Deprecated" | ||
description: |- | ||
Fetch Exoscale Compute Instances data. | ||
--- | ||
|
||
# exoscale\_compute | ||
# exoscale_compute (Data Source) | ||
|
||
!> **WARNING:** This data source is **DEPRECATED** and will be removed in the next major version. Please use [exoscale_compute_instance](./compute_instance.md) instead. | ||
|
||
## Arguments Reference | ||
|
||
* `id` - The compute instance ID to match. | ||
* `hostname` - The instance hostname to match. | ||
* `tags` - The instance tags to match (map of key/value). | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
## Attributes Reference | ||
### Optional | ||
|
||
In addition to the arguments listed above, the following attributes are exported: | ||
- `hostname` (String) The instance hostname to match. | ||
- `id` (String) The compute instance ID to match. | ||
- `tags` (Map of String) The instance tags to match (map of key/value). | ||
|
||
### Read-Only | ||
|
||
- `cpu` (Number) Number of cpu the Compute instance is running with | ||
- `created` (String) Date when the Compute instance was created | ||
- `disk_size` (Number) Size of the Compute instance disk | ||
- `ip6_address` (String) Compute instance public ipv6 address (if ipv6 is enabled) | ||
- `ip_address` (String) Compute instance public ipv4 address | ||
- `memory` (Number) Memory allocated for the Compute instance | ||
- `private_network_ip_addresses` (List of String) List of Compute instance private IP addresses (in managed Private Networks only) | ||
- `size` (String) Current size of the Compute instance | ||
- `state` (String) State of the Compute instance | ||
- `template` (String) Name of the template for the Compute instance | ||
- `zone` (String) Name of the availability zone for the Compute instance | ||
|
||
* `zone` - Exoscale Zone name. | ||
* `cpu` - The compute instance number of CPUs. | ||
* `created` - The instance creation date. | ||
* `disk_size` - The instance disk size (GiB). | ||
* `ip_address` - The instance (main network interface) IPv4 address. | ||
* `ip6_address` - The instance (main network interface) IPv6 address (if enabled). | ||
* `memory` - The instance allocated memory. | ||
* `size` - The instance size. | ||
* `state` - The current instance state. | ||
* `template` - The instance template. | ||
|
||
* `private_network_ip_addresses` - List of compute private IPv4 addresses (in *managed* private networks only). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Notice that for a nested list of objects the plugin generating the docs doesn't include the descriptions. This is unfortunately an issue we can't do much about:
hashicorp/terraform-plugin-docs#28 (comment)