Skip to content
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

How to publish docs #201

Open
andrewbaxter opened this issue Nov 22, 2022 · 2 comments
Open

How to publish docs #201

andrewbaxter opened this issue Nov 22, 2022 · 2 comments

Comments

@andrewbaxter
Copy link

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.

@jacobbednarz
Copy link
Contributor

yes, that is the general flow. the hashicorp docs have a high level overview of this too. you need to commit the files for them to be present in the registry once the provider triggers the build.

@andrewbaxter
Copy link
Author

Right, thanks, I saw that! To be clear, that page has none of the above information AFAICT. The specific request in this issue is to document this (ideally in that page).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants