terraform docs: not working links on argocd_application_set

[AkakievKD]

There is no description blocks on the Terraform Registry website

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--template

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--ignore_application_differences

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--strategy

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--sync_policy

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--generator--merge

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--generator--pull_request

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--generator--scm_provider

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--generator--selector

[AkakievKD]

this is an mirror of registry and the same in https://registry.terraform.io/

please check the description is correct

[AkakievKD]

https://argo-cd.readthedocs.io/en/latest/operator-manual/applicationset/applicationset-specification/

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[AkakievKD]

any update?

[mkilchhofer]

@AkakievKD can you point us to the links where it is not correct on https://registry.terraform.io/? That's the only location we are supporting. The other links on https://docs.comcloud.xyz/**/** are not provided by us.

[AkakievKD]

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--template

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--ignore_application_differences

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--strategy

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--sync_policy

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--generator--merge

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--generator--pull_request

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--generator--scm_provider

https://registry.terraform.io/providers/argoproj-labs/argocd/latest/docs/resources/application_set#nestedblock--spec--generator--selector

updated links @mkilchhofer these links lead to nowhere also in many of your appsets it is indicated that I can use blocks that according to the documentation are not supposed to be in these appsets

[mkilchhofer]

Alright, thanks for the update. Did you find only missing links on the resource argocd_application_set? Or are there also other links which do not work?

I ask because those documents are autogenerated using HashiCorp's SDK :)

[AkakievKD]

i sent only not working links

also in many of your appsets it is indicated that I can use blocks that according to the documentation are not supposed to be in these appsets

this means that the official documentation says that the ability to define some blocks is possible for a limited number of appsets and not for all of them. Please make a full review of the Terraform documentation for appsets

[mkilchhofer]

I assume that the root cause is the file size of the markdown file:

Storage Limits

Each document can contain no more than 500KB of data. Documents which exceed this limit will be truncated, and a note will be displayed in the Terraform Registry.

Source: https://developer.hashicorp.com/terraform/registry/providers/docs#storage-limits

The AppSet docs file is bigger than 1MB due to the complexity of the structure:

$ ls -lah docs/resources/
total 2344
drwxr-xr-x  12 mkilchhofer  staff   384B Mar 17 23:56 .
drwxr-xr-x   5 mkilchhofer  staff   160B Mar 17 23:56 ..
-rw-r--r--   1 mkilchhofer  staff   2.3K Mar 17 23:56 account_token.md
-rw-r--r--   1 mkilchhofer  staff    22K Mar 17 23:56 application.md
-rw-r--r--   1 mkilchhofer  staff   1.1M Mar 17 23:56 application_set.md # <-- see 
-rw-r--r--   1 mkilchhofer  staff   7.8K Mar 17 23:56 cluster.md
-rw-r--r--   1 mkilchhofer  staff   2.8K Mar 17 23:56 gpg_key.md
-rw-r--r--   1 mkilchhofer  staff    10K Mar 17 23:56 project.md
-rw-r--r--   1 mkilchhofer  staff   2.3K Mar 17 23:56 project_token.md
-rw-r--r--   1 mkilchhofer  staff   3.3K Mar 17 23:56 repository.md
-rw-r--r--   1 mkilchhofer  staff   2.4K Mar 17 23:56 repository_certificate.md
-rw-r--r--   1 mkilchhofer  staff   3.0K Mar 17 23:56 repository_credentials.md

Also the CLI tool tfplugindocs claims about this:

$ tfplugindocs validate
exporting schema from Terraform
compiling provider "argocd"
using Terraform CLI binary from PATH if available, otherwise downloading latest Terraform CLI binary
running terraform init
getting provider schema
2025/03/18 00:11:25 [DEBUG] Found documentation files [docs/data-sources/application.md docs/index.md docs/resources/account_token.md docs/resources/application.md docs/resources/application_set.md docs/resources/cluster.md docs/resources/gpg_key.md docs/resources/project.md docs/resources/project_token.md docs/resources/repository.md docs/resources/repository_certificate.md docs/resources/repository_credentials.md]
running mixed directories check
2025/03/18 00:11:25 [DEBUG] Found directory: docs/data-sources
2025/03/18 00:11:25 [DEBUG] Found directory: docs
2025/03/18 00:11:25 [DEBUG] Found directory: docs/resources
2025/03/18 00:11:25 [DEBUG] Found directory: docs/resources
(...)
2025/03/18 00:11:25 [DEBUG] Found datasource argocd_application
Error executing command: validation errors found:
docs/resources/application_set.md: error checking file size: exceeded maximum (500000) size of documentation file for Terraform Registry: 1127623

$ echo $?
1

[AkakievKD]

Do you have any idea how to fix this? You definitely have places where it seems to me that some blocks are duplicated, although the official documentation says that they should not be there. I will check these blocks and send links to them for you to check. You may also have to shorten some of the text that is in the description of the fields

@mkilchhofer

[AkakievKD]

any update

[mkilchhofer]

I reached out to HashiCorp and created an issue in their "autodoc" repo:

• https://github.com/hashicorp/terraform-plugin-docs/issues/480

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[AkakievKD]

mark this issue so it doesn't close automatically