From 3bb89e89d633ab4a6b47453052d0287aa734c7e2 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Mon, 28 Aug 2017 10:41:57 -0700 Subject: [PATCH] website: note repo desc for publishing, fix broken link --- website/docs/modules/create.html.markdown | 2 +- website/docs/registry/modules/publish.html.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/website/docs/modules/create.html.markdown b/website/docs/modules/create.html.markdown index ca5b8901e..b26c3c69e 100644 --- a/website/docs/modules/create.html.markdown +++ b/website/docs/modules/create.html.markdown @@ -198,7 +198,7 @@ $ tree complete-module/ ## Publishing Modules If you've built a module that you intend to be reused, we recommend -[publishing the module](/docs/registry/module/publish.html) on the +[publishing the module](/docs/registry/modules/publish.html) on the [Terraform Registry](https://registry.terraform.io). This will version your module, generate documentation, and more. diff --git a/website/docs/registry/modules/publish.html.md b/website/docs/registry/modules/publish.html.md index 07087f98d..44fc66f7d 100644 --- a/website/docs/registry/modules/publish.html.md +++ b/website/docs/registry/modules/publish.html.md @@ -38,6 +38,10 @@ where PROVIDER is the primary provider to associate with the module and NAME is a unique name for the module. The name may contain hyphens. Example: `terraform-aws-consul` or `terraform-google-vault`. +* **Repostory description.** The GitHub repository description is used +to populate the short description of the module. This should be a simple +one sentence description of the module. + * **Standard Module Structure.** The module must adhere to the [standard module structure](/docs/modules/create.html#standard-module-structure). This allows the registry to inspect your module and generate documentation,