hashicorp / hashicorp/terraform-plugin-docs

How to publish docs

Open
#201 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
263
Forks
84
Avg merge
3d 6h
Merged PRs (30d)
2

Description

This is missing from the website, not sure where to reach out.

AFAICT the way to publish docs is
- Docs are in `/docs` at top level of repo
- Docs are committed
- The docs will be shown in the registry for the git version associated with a release

Is this right? Is there a way to publish the docs without committing them (avoiding committing generated files)?

In any case though it would be good to clarify this in the documentation.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.