Skip to content

Commit aab8ed2

Browse files
authored
Fix videos in tabs and add guide (TheThingsIndustries#1412)
* doc: Fix video in tabs * doc: Add guide on embedding videos
1 parent 0eb8dfc commit aab8ed2

File tree

13 files changed

+62
-27
lines changed

13 files changed

+62
-27
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,24 @@ Please respect the following guidelines for content in our documentation site.
132132
- If a line is longer than 120 columns, insert a line break
133133
- In very special cases, longer lines are tolerated
134134

135+
## Embedding YouTube Videos
136+
137+
In most cases, YouTube videos can be embedded using it's unique ID. You can fetch this from the last part of the video's URL. For example, the unique ID for the video [https://youtu.be/vxXKBEQxLq0](https://youtu.be/vxXKBEQxLq0) is `vxXKBEQxLq0`.
138+
139+
You can embed this in markdown directly using
140+
141+
```md
142+
<details><summary>Show video</summary>
143+
{{< youtube "vxXKBEQxLq0" >}} <!-- Replace the content in the quotes with your video ID-->
144+
</details>
145+
```
146+
147+
However, if the video should be inside a `tab` container use the special `tabs/video` short code. Example below:
148+
149+
```md
150+
{{< tabs/video "vxXKBEQxLq0" >}} <!-- Replace the content in the quotes with your video ID-->
151+
```
152+
135153
## Building Frequency Plans Documentation
136154

137155
The [Frequency Plans](https://github.com/TheThingsIndustries/lorawan-stack-docs/blob/master/doc/content/concepts/features/lorawan/frequency-plans/_index.md) section contains all frequency plans that are officially supported by {{% tts %}}. The list of frequency plans is populated from the [LoRaWAN Frequency Plans for {{% tts %}} Github repository](https://github.com/TheThingsNetwork/lorawan-frequency-plans/). To update the list of frequency plans with the newest changes from the Frequency Plans repository, run `make freq.deps`.

doc/content/concepts/advanced/user-management/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This section explains how to manage users and organizations, and how to grant ri
1414

1515
<!--more-->
1616

17-
In addition to the written instructions linked below, a video with instructions for managing collaborator rights is available on [The Things Network youtube channel](https://youtu.be/-m5rULfP1yg).
17+
In addition to the written instructions linked below, a video with instructions for managing collaborator rights is available on [The Things Industries youtube channel](https://youtu.be/-m5rULfP1yg).
1818

1919
<details><summary>Show video</summary>
2020
{{< youtube "-m5rULfP1yg" >}}

doc/content/concepts/advanced/user-management/rights/_index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,9 @@ This section contains instructions for managing rights.
2020

2121
## Managing Rights using the Console
2222

23-
In addition to the written instructions linked below, a video with instructions for managing collaborator rights is available on [The Things Network youtube channel](https://youtu.be/-m5rULfP1yg).
23+
In addition to the written instructions linked below, a video with instructions for managing collaborator rights is available on [The Things Industries youtube channel](https://youtu.be/-m5rULfP1yg).
2424

25-
<details><summary>Show video</summary>
26-
{{< youtube "-m5rULfP1yg" >}}
27-
</details>
25+
{{< tabs/video "-m5rULfP1yg" >}}
2826

2927
Gateways, End Devices, and Applications have a **Collaborators** tab which allows you to specify rights for users or organizations on that entity. To manage collaborators, click the **Collaborators** tab in the left hand menu.
3028

doc/content/concepts/advanced/user-management/user/_index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,9 @@ You can search for users by ID using the search field above the list of users. I
3636

3737
### Creating Users
3838

39-
See the following video from [The Things Network youtube channel](https://youtu.be/vxXKBEQxLq0) for instructions to create a user in the console.
39+
See the following video from [The Things Industries youtube channel](https://youtu.be/vxXKBEQxLq0) for instructions to create a user in the console.
4040

41-
<details><summary>Show video</summary>
42-
{{< youtube "vxXKBEQxLq0" >}}
43-
</details>
41+
{{< tabs/video "vxXKBEQxLq0" >}}
4442

4543
### Inviting Users
4644

doc/content/concepts/features/events/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This guide shows how to view events in the console and to subscribe to events wi
1515

1616
It is possible to view live events for an entire application, gateway, or specific end device in the console.
1717

18-
See the following video from [The Things Network youtube channel](https://youtu.be/PbYzyqoJf5Q) for instructions.
18+
See the following video from [The Things Industries youtube channel](https://youtu.be/PbYzyqoJf5Q) for instructions.
1919

2020
<details><summary>Show video</summary>
2121
{{< youtube "PbYzyqoJf5Q" >}}

doc/content/concepts/features/lorawan/fuota/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,6 @@ Using multiple gateways for updating firmware on the same group of end devices i
4646

4747
## Useful Links
4848

49-
A test FUOTA server compatible with {{% tts %}} can be found [here](https://github.com/elsalahy/test-fuota-server).
50-
5149
For a beginners guide on using multicast and FUOTA, check out [this video](https://www.youtube.com/watch?v=UIF5cOpLZxE).
5250

5351
Regarding devices that implement FUOTA, we recommend you to check out our [Generic Node](https://www.genericnode.com/docs/).

doc/content/enterprise/docker/_index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
---
22
title: "Docker"
33
description: ""
4-
distributions: ["Enterprise", "Open Source"]
54
weight: 4
65
aliases:
7-
[/getting-started/installation, /the-things-stack/host/docker/installation, /the-things-stack/host/docker]
6+
[
7+
/getting-started/installation,
8+
/the-things-stack/host/docker/installation,
9+
/the-things-stack/host/docker,
10+
]
811
---
912

1013
This is a guide for installing {{% tts %}} Enterprise or Open Source on your own hardware using Docker, to run your own private LoRaWAN® network server.
@@ -21,7 +24,7 @@ For highly available production cloud deployments with high throughput, we recom
2124

2225
Continue following these instructions to run {{% tts %}} Enterprise or Open Source on your own hardware, using Docker.
2326

24-
In addition to the following written instructions, video instructions for installing {{% tts %}} are available on [The Things Network youtube channel](https://www.youtube.com/watch?v=DcmgJMvMfZc).
27+
In addition to the following written instructions, video instructions for installing {{% tts %}} are available on [The Things Industries youtube channel](https://www.youtube.com/watch?v=DcmgJMvMfZc).
2528

2629
<details><summary>Show video</summary>
2730
{{< youtube "DcmgJMvMfZc" >}}

doc/content/enterprise/docker/configuration/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This guide shows an example of configuring {{% tts %}} using configuration files
1313

1414
If configuring {{% tts %}} as `localhost` on a machine with no public IP or DNS address, see the [`localhost`](#running-the-things-stack-as-localhost) section.
1515

16-
In addition to the written instructions below, video instructions for installing {{% tts %}} are available on [The Things Network youtube channel](https://www.youtube.com/watch?v=DcmgJMvMfZc).
16+
In addition to the written instructions below, video instructions for installing {{% tts %}} are available on [The Things Industries youtube channel](https://www.youtube.com/watch?v=DcmgJMvMfZc).
1717

1818
<details><summary>Show video</summary>
1919
{{< youtube "DcmgJMvMfZc" >}}
@@ -319,7 +319,7 @@ Once you have configured `docker-compose.yml` and `ttn-lw-stack-docker.yml` as s
319319

320320
Follow this section if you are configuring and running {{% tts %}} on a local machine with no public IP or DNS address.
321321

322-
In addition to the written instructions below, video instructions for installing on `localhost` are available on [The Things Network youtube channel](https://www.youtube.com/c/TheThingsNetworkCommunity).
322+
In addition to the written instructions below, video instructions for installing on `localhost` are available on [The Things Industries youtube channel](https://www.youtube.com/c/TheThingsNetworkCommunity).
323323

324324
<details><summary>Show video</summary>
325325
{{< youtube "Owm5IUtQTx8" >}}

doc/content/hardware/devices/adding-devices/adding-devices-in-bulk/_index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,11 +82,9 @@ If the import was successful, you will see your devices added to the list of end
8282

8383
{{< figure src="successful-import.png" alt="successful-import" >}}
8484

85-
See the following video from [The Things Network youtube channel](https://youtu.be/ouz-VuiosU4) for instructions.
85+
See the following video from [The Things Industries youtube channel](https://youtu.be/ouz-VuiosU4) for instructions.
8686

87-
<details><summary>Show video</summary>
88-
{{< youtube "ouz-VuiosU4" >}}
89-
</details>
87+
{{< tabs/video "ouz-VuiosU4" >}}
9088

9189
## Claim devices using Claim Authentication Code
9290

doc/content/integrations/adding-applications/_index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,9 @@ Users have the freedom to select which devices are part of an application. Each
2525

2626
#### Adding Applications using the Console
2727

28-
In addition to the written instructions below, a video with instructions for adding an application is available on [The Things Network youtube channel](https://youtu.be/403yK_RaONE).
28+
In addition to the written instructions below, a video with instructions for adding an application is available on [The Things Industries youtube channel](https://youtu.be/403yK_RaONE).
2929

30-
<details><summary>Show video</summary>
31-
{{< youtube "403yK_RaONE" >}}
32-
</details>
30+
{{< tabs/video "403yK_RaONE" >}}
3331

3432
Go to **Applications** in the top menu, and click **+ Add Application** to reach the application registration page. Fill the application ID. The other fields are optional.
3533

0 commit comments

Comments
 (0)