Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure documentation #1394

Merged
merged 32 commits into from
Jan 20, 2025
Merged
Show file tree
Hide file tree
Changes from 30 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
1003c6b
doc: Move cloud section to top
KrishnaIyer Dec 3, 2024
f1c0ec5
doc: Update TTS Cloud clusters page
KrishnaIyer Dec 3, 2024
2d758e3
doc: Add enterprise cluster selector
KrishnaIyer Dec 3, 2024
9079265
doc: Move billing docs
KrishnaIyer Dec 3, 2024
8603e24
doc: Move alerting
KrishnaIyer Dec 3, 2024
ed17b41
doc: Move console
KrishnaIyer Dec 3, 2024
54c737a
doc: Update data formats
KrishnaIyer Dec 5, 2024
43535f7
doc: Update cloud mainpage
KrishnaIyer Dec 5, 2024
9fe9bb6
doc: Update LoRaWAN support page
KrishnaIyer Dec 5, 2024
92d34e9
doc: Move CLI
KrishnaIyer Dec 5, 2024
7f2ac96
doc: Move more topics to concepts
KrishnaIyer Dec 5, 2024
bdcb366
doc: Move enterprise items
KrishnaIyer Dec 10, 2024
490b7ec
doc: Move user management
KrishnaIyer Dec 10, 2024
e8ade44
doc: Move PacketBroker
KrishnaIyer Dec 10, 2024
a6e4b02
doc: Update migration documentation
KrishnaIyer Dec 10, 2024
95990b1
doc: Update docker
KrishnaIyer Dec 10, 2024
6416830
doc: Update AWS
KrishnaIyer Dec 10, 2024
276514d
doc: Move kubernetes
KrishnaIyer Dec 10, 2024
36b063b
doc: Remove host section
KrishnaIyer Dec 10, 2024
a97a07b
doc: Update integrations section
KrishnaIyer Dec 16, 2024
cf2640e
doc: Update gateways
KrishnaIyer Dec 16, 2024
5351356
doc: Move components
KrishnaIyer Dec 17, 2024
17e70fa
doc: Move configuration
KrishnaIyer Dec 17, 2024
1917480
doc: Move reference topics to appropriate sections
KrishnaIyer Dec 17, 2024
0370a4c
doc: Move end devices
KrishnaIyer Dec 17, 2024
4797f0f
doc: Update features pages
KrishnaIyer Dec 18, 2024
5d3c0f7
doc: Update events
KrishnaIyer Jan 13, 2025
325c2b4
doc: Update NOC content
KrishnaIyer Jan 16, 2025
331ee09
docs: Release 3.32.3 (#1392)
TheThingsBot Dec 10, 2024
748a348
doc: Move migration under concepts
KrishnaIyer Jan 16, 2025
9fc0c10
doc: Fix comments
KrishnaIyer Jan 20, 2025
36b9616
Merge branch 'master' into restructure/docs
KrishnaIyer Jan 20, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 3 additions & 5 deletions .github/ISSUE_TEMPLATE/release.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
name: Release
about: Checklist for releases

---

<!--
Expand All @@ -12,15 +11,14 @@ Please check items along as you follow the release process.

This is a checklist for releases. This is filled in by both the releaser and the reviewer where necessary.


#### Update Documentation

- [ ] Create a new release in the [`whats-new` section](https://github.com/TheThingsIndustries/lorawan-stack-docs/tree/master/doc/content/whats-new) and copy the release CHANGELOG from [TheThingsIndustries/lorawan-stack](https://github.com/TheThingsIndustries/lorawan-stack). The title is the release version and the date is the release date.
- [ ] Copy the contents of the latest UPGRADING.md from the [lorawan-stack-aws](https://github.com/TheThingsIndustries/lorawan-stack-aws) to [/the-things-stack/host/aws/ecs/changelog](https://github.com/TheThingsIndustries/lorawan-stack-docs/tree/master/doc/content/the-things-stack/host/aws/ecs/changelog/index.md)
- [ ] Copy the contents of the latest UPGRADING.md from the [lorawan-stack-aws](https://github.com/TheThingsIndustries/lorawan-stack-aws) to [/enterprise/aws/ecs/changelog](https://github.com/TheThingsIndustries/lorawan-stack-docs/tree/master/doc/content/enterprise/aws/ecs/changelog/index.md)
- [ ] Remove empty sections from the created release file.
- [ ] Update the [documentation version](https://github.com/TheThingsIndustries/lorawan-stack-docs/blob/master/doc/config/_default/config.toml#L28) to match the current PATCH, if necessary (`3.${minor}.${patch}`). Note that this previously included a "v" prefix and only included a minor, but the patch must be included or repository and CLI links will break, and no "v" should be prefixed.
- [ ] To generate documentation, create a clone of [TheThingsIndustries/lorawan-stack](https://github.com/TheThingsIndustries/lorawan-stack), and **checkout the git tag of the release**.
- [ ] To generate API documentation, run the following from within the clone of [TheThingsIndustries/lorawan-stack](https://github.com/TheThingsIndustries/lorawan-stack):
- [ ] To generate API documentation, run the following from within the clone of [TheThingsIndustries/lorawan-stack](https://github.com/TheThingsIndustries/lorawan-stack):

```bash
$ tools/bin/mage ttiProto:hugoData
Expand Down Expand Up @@ -68,7 +66,7 @@ $ rm ../lorawan-stack-docs/doc/content/ttn-lw-cli/ttn-lw-cli_end-devices.md.bak
#### Check (for reviewers)

- [ ] A new section has been created in [`whats-new`](doc/content/whats-new) with the corresponding CHANGELOG from [TheThingsIndustries/lorawan-stack](https://github.com/TheThingsIndustries/lorawan-stack). The title is the release version and the date is the release date.
- [ ] The latest UPGRADING.md from the [lorawan-stack-aws](https://github.com/TheThingsIndustries/lorawan-stack-aws) has been copied to [/the-things-stack/host/aws/ecs/changelog](https://github.com/TheThingsIndustries/lorawan-stack-docs/tree/master/doc/content/the-things-stack/host/aws/ecs/changelog/index.md)
- [ ] The latest UPGRADING.md from the [lorawan-stack-aws](https://github.com/TheThingsIndustries/lorawan-stack-aws) has been copied to [/enterprise/aws/ecs/changelog](https://github.com/TheThingsIndustries/lorawan-stack-docs/tree/master/doc/content/enterprise/aws/ecs/changelog/index.md)
- [ ] The documentation version is up to date with the latest PATCH (`3.${minor}.${patch}`). No "v" is prefixed.
- [ ] The TTI and TTN API documentation has been generated and updated in [doc/data/api](https://github.com/TheThingsIndustries/lorawan-stack-docs/blob/master/doc/data/api). This includes the following files:

Expand Down
41 changes: 20 additions & 21 deletions CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -17,33 +17,32 @@
/doc/content/integrations/payload-formatters @vlasebian @KrishnaIyer

# Subject matter experts
/doc/content/the-things-stack/interact/cli @KrishnaIyer
/doc/content/the-things-stack/interact/console @ryaplots @KrishnaIyer
/doc/content/the-things-stack/host/docker @KrishnaIyer
/doc/content/the-things-stack/host/aws @KrishnaIyer @johanstokking @happyRip
/doc/content/the-things-stack/migrating @happyRip @KrishnaIyer
/doc/content/the-things-stack/cloud @happyRip @KrishnaIyer
/doc/content/the-things-stack/management/events @johanstokking @KrishnaIyer
/doc/content/concepts/features/cli @KrishnaIyer
/doc/content/concepts/console @ryaplots @KrishnaIyer
/doc/content/enterprise/docker @KrishnaIyer
/doc/content/enterprise/aws @KrishnaIyer @johanstokking @happyRip
/doc/content/migration @happyRip @KrishnaIyer
/doc/content/cloud @happyRip @KrishnaIyer
/doc/content/concepts/features/events @johanstokking @KrishnaIyer

/doc/content/api @KrishnaIyer @johanstokking
/doc/content/reference/configuration @johanstokking @KrishnaIyer
/doc/content/the-things-stack/management/branding @ryaplots @KrishnaIyer
/doc/content/reference/email-templates @nicholaspcr @KrishnaIyer
/doc/content/enterprise/management/configuration @johanstokking @KrishnaIyer
/doc/content/cloud/branding @ryaplots @KrishnaIyer
/doc/content/reference/federated-auth @nicholaspcr @KrishnaIyer
/doc/content/reference/frequency-plans @halimi @KrishnaIyer
/doc/content/reference/interop-repository @johanstokking @halimi @KrishnaIyer
/doc/content/the-things-stack/concepts/networking @KrishnaIyer
/doc/content/reference/root-certificates @KrishnaIyer
/doc/content/concepts/features/lorawan/frequency-plans @halimi @KrishnaIyer
/doc/content/enterprise/join-server/interop-configuration @johanstokking @halimi @KrishnaIyer
/doc/content/concepts/networking @KrishnaIyer
/doc/content/concepts/advanced/root-certificates @KrishnaIyer
/doc/content/reference/stripe @mjamescompton @KrishnaIyer

# Reference components
/doc/reference/components/application-server @johanstokking @vlasebian @KrishnaIyer
/doc/reference/components/gateway-configuration-server @KrishnaIyer @nicholaspcr
/doc/reference/components/gateway-server @johanstokking @vlasebian @KrishnaIyer
/doc/reference/components/identity-server @nicholaspcr @ryaplots
/doc/reference/components/join-server @johanstokking @ryaplots @KrishnaIyer
/doc/reference/components/network-server @johanstokking @halimi @KrishnaIyer
/doc/reference/components/packet-broker-agent @johanstokking @vlasebian @KrishnaIyer
/doc/concepts/architecture/components/application-server @johanstokking @vlasebian @KrishnaIyer
/doc/concepts/architecture/components/gateway-configuration-server @KrishnaIyer @nicholaspcr
/doc/concepts/architecture/components/gateway-server @johanstokking @vlasebian @KrishnaIyer
/doc/concepts/architecture/components/identity-server @nicholaspcr @ryaplots
/doc/concepts/architecture/components/join-server @johanstokking @ryaplots @KrishnaIyer
/doc/concepts/architecture/components/network-server @johanstokking @halimi @KrishnaIyer
/doc/concepts/architecture/components/packet-broker-agent @johanstokking @vlasebian @KrishnaIyer

# Clear generated code
/doc/data/api/*/*.yml
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,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 you should not use the `{{< distributions >}}`, `{{< new-in-version >}}`, or `{{< deprecated-in-version >}}` shortcodes in a heading, as Hugo will not correctly generate the ID element for it. Put it at the beginning of the paragraph below.
- Note that you should not use the `{{< distributions >}}`, `{{< new-in-version >}}`, or `{{< deprecated-in-version >}}` shortcodes in a heading, as Hugo will not correctly generate the ID element for it. Put it at the beginning of the paragraph below.

## Style Guidelines

Expand Down Expand Up @@ -126,15 +126,15 @@ Please respect the following guidelines for content in our documentation site.
- Wrap large CLI output with `<details><summary>Show CLI output</summary> ... output here ... </details>`.
- `yaml` (not `yml`) for YAML. Wrap strings with single quotes `''` (because of frequent Go templates that use double quotes).
- For variables which a user must replace, use a command to define the variable in the shell, if possible, e.g `API_KEY="your-api-key"`.
- If not possible to define the variable, use angle brackets to indicate a variable that needs to be replaced, e.g `https://<server-address>`.
- If not possible to define the variable, use angle brackets to indicate a variable that needs to be replaced, e.g `https://<server-address>`.
- 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

## Building Frequency Plans Documentation

The [Frequency Plans](https://github.com/TheThingsIndustries/lorawan-stack-docs/blob/master/doc/content/reference/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`.
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`.

## Legal

Expand Down
15 changes: 9 additions & 6 deletions doc/archetypes/section-bundle/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ For example:
<div class="fixed-table table-name">

| Header 1 | Header 2 |
|---|---|
| Col 1 | Col 2 |
| -------- | -------- |
| Col 1 | Col 2 |

</div>

Expand Down Expand Up @@ -79,7 +79,7 @@ For an inline tag, use the `{{< new-in-version "3.8.5" >}}` shortcode to tag doc

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

## Sections

Expand All @@ -100,6 +100,7 @@ There is no need to add the word "note" at the beginning of a note, or "warning"
## Images

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.

Expand All @@ -118,7 +119,9 @@ To separate instructions for the console and CLI, use the `tabs/container` short
{{< tabs/container "Console" "CLI" >}}

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

## These are console instructions

{{< /tabs/tab >}}

{{< tabs/tab "CLI" >}}
Expand All @@ -144,7 +147,7 @@ $ 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>`.
If not possible to define the variable, use angle brackets to indicate a variable that needs to be replaced, e.g `https://<server-address>`.

## Syntax Highlighting

Expand Down Expand Up @@ -182,7 +185,7 @@ SOME_ENV="value"
# file: yaml-file.yml
services:
stack:
image: 'thethingsnetwork/lorawan-stack:<the tag>'
image: "thethingsnetwork/lorawan-stack:<the tag>"
```

### Line Breaks
Expand Down Expand Up @@ -213,5 +216,5 @@ $ curl --location --header 'Authorization: Bearer NNSXS.XXXXXXXXX' --header 'Acc
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/the-things-stack/host/docker/configuration/docker-compose-enterprise.yml" from=5 to=14 >}}
{{< readfile path="/content/enterprise/docker/configuration/docker-compose-enterprise.yml" from=5 to=14 >}}
{{< /highlight >}}
2 changes: 1 addition & 1 deletion doc/archetypes/section-bundle/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Title the troubleshooting page "Troubleshooting <name_of_section>", so that it i

## Component address is not included in this license

Ensure that you configure the `is.oauth.ui.canonical-url` with a domain that matches the domain in your license. See the [Configuration Reference]({{< ref src="/reference/configuration" >}}) for more information about the configuration options.
Ensure that you configure the `is.oauth.ui.canonical-url` with a domain that matches the domain in your license. See the [Configuration Reference]({{< ref src="/enterprise/management/configuration" >}}) for more information about the configuration options.

## Version in "docker-compose.yml" is unsupported

Expand Down
2 changes: 1 addition & 1 deletion doc/config/_default/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pygmentsUseClasses = true
github_repository = "https://github.com/TheThingsIndustries/lorawan-stack-docs"
github_repository_edit = "https://github.com/TheThingsIndustries/lorawan-stack-docs/blob/master/doc/content"
tts_github_repository = "https://github.com/TheThingsNetwork/lorawan-stack"
version = "3.32.2"
version = "3.32.3"

[markup]
[markup.goldmark]
Expand Down
3 changes: 1 addition & 2 deletions doc/content/api/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: "API"
description: ""
aliases:
["/api/reference/grpc", "/the-things-stack/interact/api/", "/reference/api"]
aliases: ["/api/reference/grpc", "/concepts/featuresapi/", "/reference/api"]
weight: 7
menu:
main:
Expand Down
5 changes: 2 additions & 3 deletions doc/content/api/concepts/auth/oauth-access-tokens/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@
title: "OAuth access tokens"
description: ""
weight: 1
aliases:
[ /api/concepts/auth/oauth-access-tokens ]
aliases: [/api/concepts/auth/oauth-access-tokens]
---

<!--more-->

To use this authentication method, you first need to [register an **OAuth client**]({{<ref "/the-things-stack/interact/adding-oauth-clients">}}) . After the registration is complete and accepted, you can **request authorization** by sending the user to the **authorization URL**:
To use this authentication method, you first need to [register an **OAuth client**]({{<ref "/concepts/advanced/adding-oauth-clients">}}) . After the registration is complete and accepted, you can **request authorization** by sending the user to the **authorization URL**:

```
https://<HOSTNAME>/oauth/authorize?client_id=<CLIENT-ID>&redirect_uri=<REDIRECT-URI>&state=<STATE>&response_type=code
Expand Down
2 changes: 1 addition & 1 deletion doc/content/api/concepts/errors/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Fields of the JSON message are described below.

## Rate limiting

API request may be subject to [rate limits]({{< ref "/reference/rate-limiting" >}}).
API request may be subject to [rate limits]({{< ref "/enterprise/management/rate-limiting" >}}).

When the rate limit is reached, the server returns a `429 Too Many Requests` response.

Expand Down
2 changes: 1 addition & 1 deletion doc/content/api/concepts/fieldmasks/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Without the field masks specified, this request would not return the `name`, `de

{{< note >}} Keep in mind that application ID (`application_ids.application_id`), end device ID (`device_id`), AppEUI/JoinEUI (`join_eui`), DevEUI (`dev_eui`) and API key IDs cannot be updated after creation. These fields are part of the allowed field mask, but they can only be used at creation, after which they can no longer be changed.

For example, to properly register an end device in {{% tts %}} like described in the [devices]({{< ref "/devices/adding-devices/manual" >}}) section, it is necessary to set the `dev_eui` field to device's DevEUI. However, updating the DevEUI after device is created will not be possible, i.e. will fail with the `forbidden path(s) in field mask` error. {{</ note >}}
For example, to properly register an end device in {{% tts %}} like described in the [devices]({{< ref "/hardware/devices/adding-devices/manual" >}}) section, it is necessary to set the `dev_eui` field to device's DevEUI. However, updating the DevEUI after device is created will not be possible, i.e. will fail with the `forbidden path(s) in field mask` error. {{</ note >}}

To update fields, the field mask must also be specified in the JSON object (query parameters do not work for `PUT` requests). The field mask has the following format:

Expand Down
Loading