---
title: "{{ replace .Name "-" " " | title }}"
description: ""
weight: 
distributions: ["Cloud", "Marketplace Launcher"]
new_in_version: "3.8.5"
---

Guidelines here are taken from CONTRIBUTING.md in this repository, which you should read. This template exists as a copy and paste starting point for new documentation. Remove the draftkey in the Front Matter to generate the page (otherwise hugo will skip it).

A documentation page starts with an introduction, and then the first heading. The first paragraph of the introduction is typically a summary of the page. Use a to indicate where the summary ends.

Use a requirements subheading to list requirements/prerequisites.

1. Requirement 1
2. Requirement 2

For custom table sizing, wrap tables in a fixed-table class div and a table-name css class with the sizes specified.

For example:

Then, add a css class table-name as follows:

.table-name {
  th:nth-child(1) {
    width: 10em;
  }
  th:nth-child(2) {
    width: 6em;
  }
}

Use the ref shortcode. For example, [this is a link to the component reference]({{< ref "reference/components" >}}).

To mark a document as applicable to only one or more distributions, do one of the following:

1. Add an array of titles to a distributions front matter element. This will mark the page in the parent's table of contents, and will produce a notification on the page
2. Use the {{< distributions "Enterprise" "Cloud" >}} shortcode to produce an inline notification on the page

Note that if you use the {{< distributions >}} shortcode in a heading, Hugo will not correctly generate the ID element for it. Manually add the heading, i.e ## Cloud Specific Section {{< distributions "Cloud" >}} {#cloud-specific-section}

Available distributions are {{< distributions-list >}} and are stored in data/distributions.yml.

{{< new-in-version "3.8.5">}} For entire pages dedicated to a feature that is new, use the Front Matter element new_in_version.

For an inline tag, use the {{< new-in-version "3.8.5" >}} shortcode to tag documentation for features added in a particular version. For documentation that targets v3.n, that's the next patch bump, e.g 3.8.x. For documentation targeting v3.n+1 that's the next minor bump, e.g 3.9.0. Check tools/bin/mage version:current for the current version.

{{< new-in-version "3.8.5">}} This is new feature text {{< new-in-version "3.8.5">}}

• This is a new feature bullet {{< new-in-version "3.8.5">}}

{{< deprecated-in-version "3.11" >}} For entire sections that are deprecated, use the Front Matter element deprecated_in_version.

For an inline tag, use the {{< deprecated-in-version "3.8.5" >}} shortcode.

You may additionally provide information using the {{< warning >}} shortcode, e.g {{< warning "This feature will be removed in January 5, 2021 for Cloud deployments" >}}

When possible, divide long documents into separate files, each with its own folder and _index.md. Use the weight tag in the Front Matter to manually sort sections if necessary. If not, they will be sorted alphabetically.

Subheadings use Title Casing. Since the title is a h1, everything in the content is at least h2 (##). Use subheadings to break up sections and provide a high level overview of steps the user should follow.

Use the {{< note "This is a note" />}} and {{< warning "This is a warning" />}} shortcodes to add a note or warning. Markdown inside the note will be processed normally. It is also possible to use these shortcodes using opening and closing tags:

{{< note >}} There is no need to add the word "note" at the beginning of a note, or "warning" at the beginning of a warning - they are automatically added for you! {{</ note >}}

Taking screenshots is done as follows:

• In Chrome: activate the Developer Tools and toggle the Device Toolbar. In the Device Toolbar, select Laptop with HiDPI screen (add it if not already there), and click Capture Screenshot in the menu on the right.
• In Firefox: enter Responsive Design Mode. In the Device Toolbar, select "Laptop with HiDPI screen" (add it if not already there) and Take a screenshot of the viewport.

Screenshots should be inserted using the figure shortcode:

{{< figure src="proxy.php?url=https%3A%2F%2Fgithub.com%2Fscreenshot.png" alt="I am a screenshot" >}}

To render images without styling, use standard markdown syntax:

To separate instructions for the console and CLI, use the tabs/container shortcode, with nested tabs/tab "Console" and tabs/tab "CLI" shortcodes, to produce a tabbed view.

{{< tabs/container "Console" "CLI" >}}

{{< tabs/tab "Console" >}}

{{< /tabs/tab >}}

{{< tabs/tab "CLI" >}} These are cli {{< /tabs/tab >}}

{{< /tabs/container >}}

Thou shalt always use the shortcode {{% tts %}} when referring to this product.

For documentation that requires the Command Line Interface, use the {{% cli-only %}} shortcode.

For variables which a user must replace, use a command to define the variable in the shell, if possible.

$ GTW_ID="your-gateway-id"
$ LNS_KEY="your-lns-api-key"
$ SECRET=$(echo $LNS_KEY | xxd -p -u | perl -pe 's/\n//')
$ ttn-lw-cli gateways update $GTW_ID --lbs-lns-secret.value $SECRET

If not possible to define the variable, use angle brackets to indicate a variable that needs to be replaced, e.g https://<server-address>.

See the following examples for types of syntax highlighting.

I am a Button in the console.

$ command_prefixed_by_dollar_sign
command_line_output

SOME_ENV="value"

# file: yaml-file.yml
services:
  stack:
    image: 'thethingsnetwork/lorawan-stack:<the tag>'

In long command line examples or other code snippets, use the following guidelines:

• If a line is longer than 80 columns, try to find a "natural" break
• If a line is longer than 120 columns, insert a line break
• In very special cases, longer lines are tolerated

For example:

$ curl --location --header 'Authorization: Bearer NNSXS.XXXXXXXXX' --header 'Accept: application/json' \
    --header 'Content-Type: application/json' --request POST 'https://thethings.example.com/api/v3/events' \
    --data-raw '{
    "identifiers":[{
        "device_ids":{
            "device_id":"dev1",
            "application_ids":{"application_id":"app1"}
        }
    }]
}'

It is also possible to host source code (or any text file) and display it using shortcodes. For example:

{{< highlight yaml "linenos=table,linenostart=5" >}} {{< readfile path="/content/getting-started/installation/configuration/docker-compose-enterprise.yml" from=5 to=14 >}} {{< /highlight >}}