website: note repo desc for publishing, fix broken link

This commit is contained in:
Mitchell Hashimoto 2017-08-28 10:41:57 -07:00 committed by Paul Banks
parent 9b363cd7d4
commit 3bb89e89d6
2 changed files with 5 additions and 1 deletions

View File

@ -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.

View File

@ -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,