Skip to content

[MAINT]: Migrate Docs from Legacy Provider Docs #2961

@deiga

Description

@deiga

Describe the need

We are currently hand rolling docs, which leads to inconsistencies in docs contents and code.

There exists a tool for auto-generating docs based on source code, which should make maintaining docs a lot simpler. We can even add a CI check that docs are up-to-date. https://github.com/hashicorp/terraform-plugin-docs

To be able to use the tool we need to Migrate from Legacy Provider Docs, which the tool is supposed to be able to do as well.

SDK Version

No response

API Version

No response

Relevant log output

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    Status: TriageThis is being looked at and prioritizedType: MaintenanceAny dependency, housekeeping, and clean up Issue or PR

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions