Skip to content

Commit

Permalink
util: Replace distributions-inline with distributions shortcode
Browse files Browse the repository at this point in the history
  • Loading branch information
benolayinka committed Feb 10, 2021
1 parent 4886016 commit b8e8958
Show file tree
Hide file tree
Showing 14 changed files with 39 additions and 39 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Mark documentation that applies only to a specific distribution in one of the fo

- Use the Front Matter `distributions` element to add a list of distributions, i.e `distribution: ["Enterprise", "Cloud"]`. This will mark the page in the parent's table of contents, and will produce a notification on the page
- Use the `{{< distributions "Enterprise" "Cloud" >}}` shortcode to produce a notification on the page
- Note that if you use the `{{< distributions >}}`, `{{< new-in-version >}}`, or `{{< deprecated-in-version >}}` shortcodes in a heading, Hugo will not correctly generate the ID element for it. [Manually add the heading](https://gohugo.io/content-management/cross-references/#heading-ids), i.e `## Cloud Specific Section {{< distributions-inline "Cloud" >}} {#cloud-specific-section}`
- Note that if you use the `{{< distributions >}}`, `{{< new-in-version >}}`, or `{{< deprecated-in-version >}}` shortcodes in a heading, Hugo will not correctly generate the ID element for it. [Manually add the heading](https://gohugo.io/content-management/cross-references/#heading-ids), i.e `## Cloud Specific Section {{< distributions "Cloud" >}} {#cloud-specific-section}`

## Style Guidelines

Expand Down
4 changes: 2 additions & 2 deletions doc/archetypes/section-bundle/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ Use a requirements subheading to list requirements/prerequisites.

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

## Distributions {{< distributions-inline "Cloud", "Enterprise" >}} {#distributions}
## Distributions {{< distributions "Cloud", "Enterprise" >}} {#distributions}

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](https://gohugo.io/content-management/cross-references/#heading-ids), i.e `## Cloud Specific Section {{< distributions-inline "Cloud" >}} {#cloud-specific-section}`
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](https://gohugo.io/content-management/cross-references/#heading-ids), i.e `## Cloud Specific Section {{< distributions "Cloud" >}} {#cloud-specific-section}`

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ The example `ttn-lw-stack-docker.yml` file for {{% tts %}} Enterprise shown belo

{{< note >}} The example `ttn-lw-stack-docker.yml` file is available for download in the [Example Configuration Files]({{< ref "/getting-started/installation/configuration#example-configuration-files" >}}) section. {{</ note >}}

### License {{< distributions-inline "Enterprise" >}} {#license}
### License {{< distributions "Enterprise" >}} {#license}

{{% tts %}} Enterprise requires a license, which can be purchased at the [products page](https://thethingsindustries.com/technology/pricing). This is specified in the `license` field, and can be either a `key` string, or a `file`path. See the [License configuration reference]({{< ref "/reference/configuration/the-things-stack#license" >}}) for more information.

Expand Down Expand Up @@ -164,7 +164,7 @@ by the console client. These tell {{% tts %}} where all its components are acces

{{< note >}} Note that the `client-secret` will be needed later when authorizing the Console. {{</ note >}}

### Multi-tenancy {{< distributions-inline "Enterprise" >}} {#multi-tenancy}
### Multi-tenancy {{< distributions "Enterprise" >}} {#multi-tenancy}

If running a multi-tenant environment, we need to configure the default tenant ID, and the base domain from which tenant IDs are inferred. See the [`tenancy` configuration reference]({{< ref "/reference/configuration/the-things-stack#multi-tenancy" >}}).

Expand Down
2 changes: 1 addition & 1 deletion doc/content/getting-started/migrating/migrating-from-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ For a breakdown of differences between {{% ttnv2 %}} and {{% tts %}}, see the [M

**Finally**: Once you are confident that your end devices are working properly, migrate the rest of your devices and gateways to {{% tts %}}.

## Migrating Active Sessions {{< distributions-inline "Cloud" >}}
## Migrating Active Sessions {{< distributions "Cloud" >}}

When migrating devices from the public {{< ttnv2 >}} to {{< tts >}} Cloud, you may choose to transfer the active device sessions as well, which means that your devices will continue to work with {{% tts %}} without rejoining.

Expand Down
4 changes: 2 additions & 2 deletions doc/content/integrations/aws-iot/default/deployment-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ The **Stack name** is the unique name identifying the integration in your AWS ac

The parameters configure the integration:

- **Principal Account ID** {{< distributions-inline "Enterprise" >}}: AWS Account ID that The Things Stack authenticates with.
- **Principal Account ID** {{< distributions "Enterprise" >}}: AWS Account ID that The Things Stack authenticates with.
- **Thing Type Name**: The unique AWS IoT Core thing type name for this integration.
- **Thing Shadow Metrics**: Enable or disable updating the thing shadow with metrics.
- **Cluster Address**: The cluster address of your {{% tts %}} deployment, for example `mycompany.eu1.cloud.thethings.industries`. See [Cloud Hosted Addresses]({{< relref "/getting-started/cloud-hosted/addresses" >}}) to find your cluster address.
- **Enable End-to-End Encryption** {{< new-in-version "3.10.0" >}} {{< distributions-inline "Cloud" >}}: If enabled, the AppSKey is delivered as encrypted from The Things Join Server to your AWS Account, so the AppSKey will not be exposed to the network layer. Also, your AWS solution needs to handle binary payload as the underlying network cannot run payload encoding and decoding functions.
- **Enable End-to-End Encryption** {{< new-in-version "3.10.0" >}} {{< distributions "Cloud" >}}: If enabled, the AppSKey is delivered as encrypted from The Things Join Server to your AWS Account, so the AppSKey will not be exposed to the network layer. Also, your AWS solution needs to handle binary payload as the underlying network cannot run payload encoding and decoding functions.
- **Application ID**: The application ID for which you configure the integration.
- **Application API Key**: The application API key that you generated before.

Expand Down
10 changes: 5 additions & 5 deletions doc/content/reference/branding/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ It is possible to change the logos of the web UI by changing the "branding base
| console-favicon.ico | multiple | The fallback favicon logo for the console in `ICO` format; recommended size 32x32 |
| console-og-image.png | 1200x600 | The logo for the console that is shown when sharing links on social media |
| console-touch-icon.png | 400x400 | The logo for the console that is shown mobile devices |
| claim-favicon.svg {{< distributions-inline "Cloud" "Enterprise" >}} | vector | The SVG logo for the device claiming frontend that is shown in browser tabs and bookmarks |
| claim-favicon.png {{< distributions-inline "Cloud" "Enterprise" >}} | multiple | The fallback favicon logo for the device claiming frontend in `PNG` format; recommended size 32x32 |
| claim-favicon.ico {{< distributions-inline "Cloud" "Enterprise" >}} | multiple | The fallback favicon logo for the device claiming frontend in `ICO` format; recommended size 32x32 |
| claim-og-image.png {{< distributions-inline "Cloud" "Enterprise" >}} | 1200x600 | The logo for the device claiming frontend that is shown when sharing links on social media |
| claim-touch-icon.png {{< distributions-inline "Cloud" "Enterprise" >}} | 400x400 | The logo for the device claiming frontend that is shown mobile devices |
| claim-favicon.svg {{< distributions "Cloud" "Enterprise" >}} | vector | The SVG logo for the device claiming frontend that is shown in browser tabs and bookmarks |
| claim-favicon.png {{< distributions "Cloud" "Enterprise" >}} | multiple | The fallback favicon logo for the device claiming frontend in `PNG` format; recommended size 32x32 |
| claim-favicon.ico {{< distributions "Cloud" "Enterprise" >}} | multiple | The fallback favicon logo for the device claiming frontend in `ICO` format; recommended size 32x32 |
| claim-og-image.png {{< distributions "Cloud" "Enterprise" >}} | 1200x600 | The logo for the device claiming frontend that is shown when sharing links on social media |
| claim-touch-icon.png {{< distributions "Cloud" "Enterprise" >}} | 400x400 | The logo for the device claiming frontend that is shown mobile devices |
| logo.svg | vector | The logo for the console that is shown in the menu bar of the console |
| oauth-favicon.svg | vector | The SVG logo for the login pages that is shown in browser tabs and bookmarks |
| oauth-favicon.png | multiple | The fallback favicon logo for the login pages in `PNG` format; recommended size 32x32 |
Expand Down
4 changes: 2 additions & 2 deletions doc/content/reference/configuration/console.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ You can control the url of the assets folder that the Console frontend will use,

- `console.ui.assets-base-url`: The base URL to the page assets
- `console.ui.branding-base-url`: The base URL to the branding assets
- `console.ui.branding-cluster-id`: The cluster ID to show below the logo {{< distributions-inline "Cloud" "Enterprise" >}}
- `console.ui.branding-text`: The branding text to show below the logo {{< distributions-inline "Cloud" "Enterprise" >}}
- `console.ui.branding-cluster-id`: The cluster ID to show below the logo {{< distributions "Cloud" "Enterprise" >}}
- `console.ui.branding-text`: The branding text to show below the logo {{< distributions "Cloud" "Enterprise" >}}
- `console.ui.icon-prefix`: The prefix to put before the page icons (favicon.ico, touch-icon.png, og-image.png)
- `console.ui.canonical-url`: The page canonical URL
- `console.ui.descriptions`: The page description
Expand Down
10 changes: 5 additions & 5 deletions doc/content/reference/configuration/identity-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: ''
The Identity Server needs to be connected to a PostgreSQL-compatible database. Details for the form of the URI can be found in the [PostgreSQL documentation](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING).

- `is.database-uri`: Database connection URI
- `is.read-database-uri`: Read-Only database connection URI {{< distributions-inline "Cloud" "Enterprise" >}}
- `is.read-database-uri`: Read-Only database connection URI {{< distributions "Cloud" "Enterprise" >}}

## Email Options

Expand Down Expand Up @@ -66,8 +66,8 @@ If page assets for the OAuth UI are served from a CDN or on a different path on

- `is.oauth.ui.assets-base-url`: The base URL to the page assets
- `is.oauth.ui.branding-base-url`: The base URL to the branding assets
- `is.oauth.ui.branding-cluster-id`: The cluster ID to show below the logo {{< distributions-inline "Cloud" "Enterprise" >}}
- `is.oauth.ui.branding-text`: The branding text to show below the logo {{< distributions-inline "Cloud" "Enterprise" >}}
- `is.oauth.ui.branding-cluster-id`: The cluster ID to show below the logo {{< distributions "Cloud" "Enterprise" >}}
- `is.oauth.ui.branding-text`: The branding text to show below the logo {{< distributions "Cloud" "Enterprise" >}}

The appearance of {{% tts %}} can optionally be customized.

Expand Down Expand Up @@ -146,8 +146,8 @@ By default admins are granted _almost_ all rights on all entities in the network

- `is.gateways.encryption-key-id`: ID of the key used to encrypt gateway secrets at rest.

## Tenant Administration Options {{< distributions-inline "Cloud" "Enterprise" >}} {#tenant-administration-options}
## Tenant Administration Options {{< distributions "Cloud" "Enterprise" >}} {#tenant-administration-options}

In multi-tenant deployments, tenants are managed with "tenant admin keys". These keys need to be configured in the Identity Server.

- `is.tenancy.admin-keys`: Keys that can be used for tenant administration (16, 24 or 32 hex-encoded bytes) {{< distributions-inline "Cloud" "Enterprise" >}}
- `is.tenancy.admin-keys`: Keys that can be used for tenant administration (16, 24 or 32 hex-encoded bytes) {{< distributions "Cloud" "Enterprise" >}}
4 changes: 2 additions & 2 deletions doc/content/reference/configuration/network-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ The `ns.interop` options configure how Network Server performs interoperability
- `ns.interop.directory`: OS filesystem directory, which contains interoperability client configuration
- `ns.interop.url`: URL, which contains interoperability client configuration

## Peering {{< distributions-inline "Cloud" "Enterprise" >}} {#peering}
## Peering {{< distributions "Cloud" "Enterprise" >}} {#peering}

In multi-tenant deployments, the Network Server maintains strict isolation of traffic for different tenants. When it also has peering configured, the Packet Broker is typically configured with the correct tenant ID for the DevAddr ranges of each tenant. It is also possible to accept traffic from the Packet Broker without a tenant ID, and let the Network Server match devices without strict tenant isolation.

- `ns.switch-peering-tenant-context`: Switch tenant context in peering {{< distributions-inline "Cloud" "Enterprise" >}}
- `ns.switch-peering-tenant-context`: Switch tenant context in peering {{< distributions "Cloud" "Enterprise" >}}
28 changes: 14 additions & 14 deletions doc/content/reference/configuration/the-things-stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ Under normal circumstances, only `info`, `warn` and `error` logs are printed to

- `log.level`: The minimum level log messages must have to be shown (default "info")

## License {{< distributions-inline "Cloud" "Enterprise" >}} {#license}
## License {{< distributions "Cloud" "Enterprise" >}} {#license}

{{% tts %}} requires a license key for production use. For development purposes, it will work for a limited time on `localhost` without a license key.

- `license.file`: Location of the license file
- `license.key`: Contents of the license key

## Key Vault {{< distributions-inline "Cloud" "Enterprise" >}} {#key-vault}
## Key Vault {{< distributions "Cloud" "Enterprise" >}} {#key-vault}

The key vault is used to store secrets, such as TLS certificates and the keys for encrypting LoRaWAN root keys in the database. {{% tts %}} supports keys stored in AWS Secrets Manager, or static configuration for development purposes.

Expand Down Expand Up @@ -158,10 +158,10 @@ Or you can enable failover using [Redis Sentinel](https://redis.io/topics/sentin

Further, you can reduce the load on the Redis master by specifying read-only configuration:

- `redis.readonly.address`: Address of the Redis server {{< distributions-inline "Cloud" "Enterprise" >}}
- `redis.readonly.password`: Password of the Redis server {{< distributions-inline "Cloud" "Enterprise" >}}
- `redis.readonly.database`: Redis database to use {{< distributions-inline "Cloud" "Enterprise" >}}
- `redis.readonly.pool-size`: The maximum size of the connection pool {{< distributions-inline "Cloud" "Enterprise" >}}
- `redis.readonly.address`: Address of the Redis server {{< distributions "Cloud" "Enterprise" >}}
- `redis.readonly.password`: Password of the Redis server {{< distributions "Cloud" "Enterprise" >}}
- `redis.readonly.database`: Redis database to use {{< distributions "Cloud" "Enterprise" >}}
- `redis.readonly.pool-size`: The maximum size of the connection pool {{< distributions "Cloud" "Enterprise" >}}

If your Redis server uses TLS, use the following options:

Expand Down Expand Up @@ -208,10 +208,10 @@ When using the `redis` backend, the global [Redis configuration]({{< ref "#redis

Similar to the global Redis configuration, you can reduce the load on the Redis master by specifying read-only configuration:

- `events.redis.readonly.address`: Address of the Redis server {{< distributions-inline "Cloud" "Enterprise" >}}
- `events.redis.readonly.password`: Password of the Redis server {{< distributions-inline "Cloud" "Enterprise" >}}
- `events.redis.readonly.database`: Redis database to use {{< distributions-inline "Cloud" "Enterprise" >}}
- `events.redis.readonly.pool-size`: The maximum size of the connection pool {{< distributions-inline "Cloud" "Enterprise" >}}
- `events.redis.readonly.address`: Address of the Redis server {{< distributions "Cloud" "Enterprise" >}}
- `events.redis.readonly.password`: Password of the Redis server {{< distributions "Cloud" "Enterprise" >}}
- `events.redis.readonly.database`: Redis database to use {{< distributions "Cloud" "Enterprise" >}}
- `events.redis.readonly.pool-size`: The maximum size of the connection pool {{< distributions "Cloud" "Enterprise" >}}

If your Redis server uses TLS, use the following options:

Expand Down Expand Up @@ -291,13 +291,13 @@ When using the `redis` backend, the global [Redis configuration]({{< ref "#redis
- `cache.redis.namespace`: Namespace for Redis keys
- `cache.redis.pool-size`: The maximum size of the connection pool

## Multi-Tenancy {{< distributions-inline "Cloud" "Enterprise" >}} {#multi-tenancy}
## Multi-Tenancy {{< distributions "Cloud" "Enterprise" >}} {#multi-tenancy}

In multi-tenant deployments, some additional configuration is required.

- `tenancy.base-domains`: Base domains for tenant ID inference. Setting this to `thethings.example.com` would extract the tenant ID from `<tenant-id>.thethings.example.com`. {{< distributions-inline "Cloud" "Enterprise" >}}
- `tenancy.default-id`: Default tenant ID. Users visiting `thethings.example.com` (from `tenancy.base-domains`) will be redirected to `default.thethings.example.com`. {{< distributions-inline "Cloud" "Enterprise" >}}
- `tenancy.base-domains`: Base domains for tenant ID inference. Setting this to `thethings.example.com` would extract the tenant ID from `<tenant-id>.thethings.example.com`. {{< distributions "Cloud" "Enterprise" >}}
- `tenancy.default-id`: Default tenant ID. Users visiting `thethings.example.com` (from `tenancy.base-domains`) will be redirected to `default.thethings.example.com`. {{< distributions "Cloud" "Enterprise" >}}

Tenants can have custom configuration, such as custom branding or custom user registration options. This information is typically cached locally, especially in multi-region deployments to reduce the load on the Identity Server and to be more resilient against outages of the Identity Server.

- `tenancy.ttl`: TTL of cached tenant configurations {{< distributions-inline "Cloud" "Enterprise" >}}
- `tenancy.ttl`: TTL of cached tenant configurations {{< distributions "Cloud" "Enterprise" >}}
2 changes: 1 addition & 1 deletion doc/content/reference/email-templates/available.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The following email templates are currently used by {{% tts %}}:

Full Name | Identifier | Scope | Additional fields
----------|------------|-------|------------------
Tenant Created | `tenant_created` | Sent to the initial user of a tenant when it is first created. {{< distributions-inline "Cloud" "Enterprise" >}} | `InitialPassword`
Tenant Created | `tenant_created` | Sent to the initial user of a tenant when it is first created. {{< distributions "Cloud" "Enterprise" >}} | `InitialPassword`
Invitation | `invitation` | Sent when inviting new users to the network. | `InvitationToken`, `TTL`
API Key changed | `api_key_changed` | Sent when the rights of an API Key have been changed. | `Identifiers` and `Rights`
API Key created | `api_key_created` | Send when an API Key has been created. | `Identifiers` and `Rights`
Expand Down
2 changes: 1 addition & 1 deletion doc/content/reference/networking/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The following table lists the default ports used.
| Management | HTTP | API key, token | 1885 | 8885 |
| Backend Interfaces | HTTP | Custom | N/A | 8886 |
| {{% lbs %}} LNS | Web Sockets | Auth Token, Custom | 1887 | 8887 |
| Tabs Hubs LNS {{< distributions-inline "Cloud" "Enterprise" >}} | Web Sockets | Auth Token, Custom | 1888 | 8888 |
| Tabs Hubs LNS {{< distributions "Cloud" "Enterprise" >}} | Web Sockets | Auth Token, Custom | 1888 | 8888 |

## Service Discovery

Expand Down
Loading

0 comments on commit b8e8958

Please sign in to comment.