Restructure documentation #1394
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KrishnaIyer
requested review from
mjamescompton,
johanstokking,
halimi,
nicholaspcr,
ryaplots,
happyRip and
vlasebian
as code owners
halimi
approved these changes
Jan 16, 2025
| | Component (Service) | Short | Description | | ||
| | ------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | Tenant Billing Server | `TBS` | Manages the creation, suspension and billing of tenants using different payment backends (only for {{% tts %}} cloud). | | ||
| | QR Generator | `QRG` | Generates QR codes for devices in various formats. These QR codes can be used for various purposes, including identification and device claiming to transfer ownership.. | |
There was a problem hiding this comment.
Suggested change
| | QR Generator | `QRG` | Generates QR codes for devices in various formats. These QR codes can be used for various purposes, including identification and device claiming to transfer ownership.. | | |
| | QR Generator | `QRG` | Generates QR codes for devices in various formats. These QR codes can be used for various purposes, including identification and device claiming to transfer ownership.. | |
Suggested change
| | QR Generator | `QRG` | Generates QR codes for devices in various formats. These QR codes can be used for various purposes, including identification and device claiming to transfer ownership.. | | |
| | QR Generator | `QRG` | Generates QR codes for devices in various formats. These QR codes can be used for various purposes, including identification and device claiming to transfer ownership. | |
vlasebian
approved these changes
Jan 17, 2025
| aliases: [the-things-stack/concepts/architecture] | ||
| --- | ||
|
|
||
| {{% tts %}} follows a API driven microservice architecture, well suited for high availability and reliability. |
There was a problem hiding this comment.
Suggested change
| {{% tts %}} follows a API driven microservice architecture, well suited for high availability and reliability. | |
| {{% tts %}} follows an API driven microservice architecture, well suited for high availability and reliability. |
| @@ -14,11 +14,11 @@ This error usually occurs when wrong path(s) are specified in the `field_mask` o | |||
|
|
|||
| ###### When adding a device, I get an "invalid end_device: embedded message failed validation" error. | |||
|
|
|||
| The most common cause for this error is not following the regex pattern in the `device_id` field. See [End Device APIs]({{< ref "/api/reference/grpc/end_device#message:EndDeviceIdentifiers" >}}) section and make sure your `device_id` is in line with the defined regex pattern. See also [ID and EUI constaints]({{< ref "/reference/id-eui-constraints" >}}) documentation. | |||
| The most common cause for this error is not following the regex pattern in the `device_id` field. See [End Device APIs]({{< ref "/api/reference/grpc/end_device#message:EndDeviceIdentifiers" >}}) section and make sure your `device_id` is in line with the defined regex pattern. See also [ID and EUI constaints]({{< ref "/concepts/architecture/id-eui-constraints" >}}) documentation. | |||
There was a problem hiding this comment.
Suggested change
| The most common cause for this error is not following the regex pattern in the `device_id` field. See [End Device APIs]({{< ref "/api/reference/grpc/end_device#message:EndDeviceIdentifiers" >}}) section and make sure your `device_id` is in line with the defined regex pattern. See also [ID and EUI constaints]({{< ref "/concepts/architecture/id-eui-constraints" >}}) documentation. | |
| The most common cause for this error is not following the regex pattern in the `device_id` field. See [End Device APIs]({{< ref "/api/reference/grpc/end_device#message:EndDeviceIdentifiers" >}}) section and make sure your `device_id` is in line with the defined regex pattern. See also [ID and EUI constraints]({{< ref "/concepts/architecture/id-eui-constraints" >}}) documentation. |
mjamescompton
requested changes
Jan 17, 2025
There was a problem hiding this comment.
Looks great, much prefer the new structure but we need to create 301 redirects for every URL change so that all our search results to go to 404s.
This a pain to do with hugo and github pages as we don't have something like nginx where we can write this.
This look like the best bet. I'm just testing it now
Hmm, I don't understand. We already use aliases and that's how we've always handled moving pages. |
|
@KrishnaIyer Sorry looks like they are there just did not work the first time I ran |
|
And this was the first one I checked |
mjamescompton
requested changes
Jan 17, 2025
| @@ -1,7 +1,8 @@ | |||
| --- | |||
| title: "Troubleshooting CLI" | |||
| description: "" | |||
| aliases: [/getting-started/cli/troubleshooting] | |||
| aliases: | |||
| [/getting-started/cli/troubleshooting, /concepts/features/cli/troubleshooting] | |||
There was a problem hiding this comment.
This alias is to the new file location not the old. It should be the-things-stack/interact/cli/troubleshooting/
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Restructure documentation.
Changes
98% of the content is just updating links and aliases.
Update aliases. Missing aliases checked using the alias check tool:
Screenshots
Notes for Reviewers
To do
Checklist
make server, posted screenshots, verified external links. Test withHUGO_PARAMS_SEARCH_ENABLED=trueif style changes will affect the search bar.new-in-versionshortcode, according to the guidelines in CONTRIBUTING.