From 24064c4ed93240a5ced631efaf592b0b5f7a0262 Mon Sep 17 00:00:00 2001 From: Justin Campbell Date: Mon, 20 Jul 2020 12:28:55 -0400 Subject: [PATCH] website: Add links to registry doc preview tool (#25619) --- website/docs/registry/providers/docs.html.md | 4 ++-- website/docs/registry/providers/publishing.html.md | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/website/docs/registry/providers/docs.html.md b/website/docs/registry/providers/docs.html.md index 7f2e25cb4..d41cdc6f8 100644 --- a/website/docs/registry/providers/docs.html.md +++ b/website/docs/registry/providers/docs.html.md @@ -10,9 +10,9 @@ description: |- The [Terraform Registry][terraform-registry] displays documentation for the providers it hosts. This page describes the expected format for provider documentation. -## Publishing +-> In order to test how documents will render in the Terraform Registry, you can use the [Terraform Registry Doc Preview Tool](https://registry.terraform.io/tools/doc-preview). --> **Note:** Publishing is currently in a closed beta. Although we do not expect this document to change significantly before opening provider publishing to the community, this reference currently only applies to providers already appearing on the [Terraform Registry providers list][terraform-registry-providers]. +## Publishing The Terraform Registry publishes providers from their Git repositories, creating a version for each Git tag that matches the [Semver](https://semver.org/) versioning format. Provider documentation is published automatically as part of the provider release process. diff --git a/website/docs/registry/providers/publishing.html.md b/website/docs/registry/providers/publishing.html.md index 4f1793dea..82552a4ce 100644 --- a/website/docs/registry/providers/publishing.html.md +++ b/website/docs/registry/providers/publishing.html.md @@ -40,6 +40,8 @@ All Terraform Verified providers must contain one of the following open source l Your provider should contain an overview document (index.md), as well as a doc for each resource and data-source. See [Documenting Providers](./docs.html) for details about how to ensure your provider documentation renders properly on the Terraform Registry. +-> In order to test how documents will render in the Terraform Registry, you can use the [Terraform Registry Doc Preview Tool](https://registry.terraform.io/tools/doc-preview). + ### Creating a GitHub Release Publishing a provider requires at least one version be available on GitHub Releases. The tag must be a valid [Semantic Version](https://semver.org/) preceded with a `v` (for example, `v1.2.3`).