{"id":19806008,"url":"https://github.com/cycloidio/tfdocs","last_synced_at":"2025-07-06T23:05:16.428Z","repository":{"id":50938225,"uuid":"190622851","full_name":"cycloidio/tfdocs","owner":"cycloidio","description":"Generated structured documentation for Terraform Providers","archived":false,"fork":false,"pushed_at":"2023-05-16T09:56:48.000Z","size":17349,"stargazers_count":6,"open_issues_count":7,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-01T07:37:00.228Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cycloidio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-06T17:32:13.000Z","updated_at":"2025-02-17T03:11:00.000Z","dependencies_parsed_at":"2024-06-18T23:10:44.577Z","dependency_job_id":null,"html_url":"https://github.com/cycloidio/tfdocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cycloidio/tfdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycloidio%2Ftfdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycloidio%2Ftfdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycloidio%2Ftfdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycloidio%2Ftfdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cycloidio","download_url":"https://codeload.github.com/cycloidio/tfdocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cycloidio%2Ftfdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263986225,"owners_count":23539808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T09:06:09.397Z","updated_at":"2025-07-06T23:05:16.403Z","avatar_url":"https://github.com/cycloidio.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tfdocs\n\nThis package is autogenerated from the [Terraform Registry](https://registry.terraform.io/browse/providers) for all the providers that are Official and Verified. If one is missing we can manually add them.\n\nIn the `cmd/` there is the logic to generate the actual documentation of each Provider.\n\nThe generated documentation is placed inside a package `providers/` with the name of the provider, so for `aws` would be `providers/aws`. Inside of it there are 2 files, one for the Resources (`r.go`) and another for the DataSources (`d.go`).\n\n## Documentation\n\nEach Provider package have the same 4 exported varables and functions\n\nThe exported variables and functions are:\n\n### `var Resources []*Resource`:\n\nList of all the Resources of the Provider\n\n### `func GetResource(r string) (*resource.Resource, error)`:\n\nReturns the specific Resource for the resource type, example: `aws_iam_user`\n\n### `var DataSources []*Resource`:\n\nList of all the DataSources of the Provider\n\n### `func GetDataSource(r string) (*resource.Resource, error)`:\n\nReturns the specific DataSource for the resource type, example: `aws_vpcs`\n\n## Icons (`assets/`)\n\nTo add icons we need a JSON that connects the resource name (`aws_lb`) to the actual path (`Compute/Elastic-Load-Balancing-ELB.svg`). This is done inside the `assets/` directory, there we have a folder for each Provider that may have icons. The path to the actual JSON has to be `assets/{{ ProviderName }}/icons.json` and for the format is a simple KV where K == resource name and V == path.\n\nThe path has to be the one from the official Provider source after download:\n* aws: https://aws.amazon.com/architecture/icons/ (currently the 20200430)\n* google: https://cloud.google.com/icons\n* openstack: https://github.com/openstack/horizon/tree/master/openstack_dashboard/static/dashboard/img\n* azurerm: https://docs.microsoft.com/en-us/azure/architecture/icons/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcycloidio%2Ftfdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcycloidio%2Ftfdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcycloidio%2Ftfdocs/lists"}