Commit 88583e09 authored by Marcia Ramos's avatar Marcia Ramos

Merge branch 'remove-misleading-underscores' into 'master'

Doc: Remove misleading underscores in variable name examples

See merge request gitlab-org/gitlab!74736
parents a21b037b fbe37f11
...@@ -29,15 +29,15 @@ Prerequisites: ...@@ -29,15 +29,15 @@ Prerequisites:
- You need to [authenticate with the API](../../../api/index.md#authentication). If authenticating with a deploy token, it must be configured with the `write_package_registry` scope. - You need to [authenticate with the API](../../../api/index.md#authentication). If authenticating with a deploy token, it must be configured with the `write_package_registry` scope.
```plaintext ```plaintext
PUT /projects/:id/packages/terraform/modules/:module_name/:module_system/:module_version/file PUT /projects/:id/packages/terraform/modules/:module-name/:module-system/:module-version/file
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| -------------------| --------------- | ---------| -------------------------------------------------------------------------------------------------------------------------------- | | -------------------| --------------- | ---------| -------------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../../../api/index.md#namespaced-path-encoding). | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](../../../api/index.md#namespaced-path-encoding). |
| `module_name` | string | yes | The package name. It can contain only lowercase letters (`a-z`), uppercase letter (`A-Z`), numbers (`0-9`), or hyphens (`-`) and cannot exceed 64 characters. | `module-name` | string | yes | The package name. It can contain only lowercase letters (`a-z`), uppercase letter (`A-Z`), numbers (`0-9`), or hyphens (`-`) and cannot exceed 64 characters.
| `module_system` | string | yes | The package system. It can contain only lowercase letters (`a-z`) and numbers (`0-9`), and cannot exceed 64 characters. | `module-system` | string | yes | The package system. It can contain only lowercase letters (`a-z`) and numbers (`0-9`), and cannot exceed 64 characters.
| `module_version` | string | yes | The package version. It must be valid according to the [Semantic Versioning Specification](https://semver.org/). | `module-version` | string | yes | The package version. It must be valid according to the [Semantic Versioning Specification](https://semver.org/).
Provide the file content in the request body. Provide the file content in the request body.
...@@ -97,7 +97,7 @@ You can then reference your Terraform Module from a downstream Terraform project ...@@ -97,7 +97,7 @@ You can then reference your Terraform Module from a downstream Terraform project
```plaintext ```plaintext
module "<module>" { module "<module>" {
source = "gitlab.com/<namespace>/<module_name>/<module_system>" source = "gitlab.com/<namespace>/<module-name>/<module-system>"
} }
``` ```
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment