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

Update images with new UI #1373

Merged
merged 4 commits into from
Sep 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions doc/content/api/concepts/auth/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,9 @@ In this section we explain how to create a _user API key_, which can be used to

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

In the users dropdown on the right side, select the **Personal API Keys** option and select **+Add API Key**.
In the **User settings** dropdown on the left-hand sidebar, select the **API Keys** option and select **+ Add API Key**.

{{< figure src="personal-api-keys.png" alt="Personal API key" >}}
{{< figure src="add-api-key-button.png" alt="Add API key" >}}

Choose an optional expiry date and choose the required rights.
{{< figure src="application-rights.png" alt="Selectable rights" >}}
Expand Down
Binary file not shown.
Binary file modified doc/content/api/concepts/auth/application-rights.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/content/api/concepts/auth/copy-api-key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ To register OAuth client you can use {{% tts %}} [Console]({{< ref "/the-things-

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

To register an OAuth client using the Console, first navigate to `https://<HOSTNAME>/oauth` in your web browser to log into your Account App. When logged in, switch to the **OAuth Clients** tab on the top menu and click the **Add OAuth Client** button.
To register an OAuth client using the Console, click the **User settings** dropdown in the left-hand sidebar and select **OAuth clients**. Then click **+ Add OAuth client** in the top-right.

{{< figure src="oauth-client.png" alt="OAuth client" >}}

Enter the **OAuth Client ID**, **Name** and **Description** for your OAuth client. You can also add the **Redirect URLs** against which authorization requests will be checked, and **Logout redirect URLs** agains which client initiated requests are checked.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/content/api/concepts/auth/personal-api-keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/content/api/concepts/auth/rights-all.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions doc/content/devices/adding-devices/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This guide assumes that your device is in the [LoRaWAN® Device Repository](http

To create a device, first open the application you wish to add the device in. Go to **End devices** in the left menu and click on **+Register end device** to reach the end device registration page.

{{< figure src="application-overview.png" alt="Application overview" >}}
{{< figure src="application-end-devices.png" alt="Application overview" >}}

You will be presented with options to easily onboard your device using its QR code (if you have it), and to register your end device from the [LoRaWAN® Device Repository](https://github.com/TheThingsNetwork/lorawan-devices/) or manually.

Expand Down Expand Up @@ -83,7 +83,7 @@ For LoRaWAN version 1.0.x devices, you will see an **AppKey** field, and for LoR

{{< /tabs/container >}}

Finally, the console pre-fills **End device ID** in the format `eui-{Device EUI}` by default. You can edit this field and give the device a unique identifier. See [ID and EUI constraints]({{< ref "reference/id-eui-constraints" >}}) for guidelines about choosing a unique ID.
Finally, enter an **End device ID**. Advisable is doing it in the format `eui-{Device EUI}`. You can edit this field and give the device a unique identifier. See [ID and EUI constraints]({{< ref "reference/id-eui-constraints" >}}) for guidelines about choosing a unique ID.

Now verify that all the fields are filled and click the **Register end device** button to create the end device.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file removed doc/content/devices/adding-devices/device-id.png
Binary file not shown.
Binary file not shown.
Binary file modified doc/content/devices/adding-devices/device-repo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/content/devices/adding-devices/fp-non-qr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/content/devices/adding-devices/fp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion doc/content/devices/adding-devices/manual/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ Choosing the incorrect LoRaWAN version can lead to complex errors. Activation ma

{{< figure src="device-input-method.png" alt="ABP input method" >}}

The above fields are common for both OTAA and ABP devices. Now, based on the device you are trying to add, choose the speficic guide for OTAA or ABP below.
The above fields are common for both OTAA and ABP devices. Now, based on the device you are trying to add, choose the specific guide for OTAA or ABP below.
Binary file modified doc/content/devices/adding-devices/manual/abp/abp-fields-set.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Diff not rendered.
Binary file modified doc/content/devices/adding-devices/non-qr-all-set.png
Binary file modified doc/content/devices/adding-devices/non-qr-join-eui.png
Diff not rendered.
Binary file modified doc/content/devices/adding-devices/qr-data-found.png
Binary file modified doc/content/devices/adding-devices/register-devices-option.png
Binary file modified doc/content/devices/adding-devices/select-dr-non-qr.png
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ The end device location can be manually set in two ways.
1. Pinning the location on the map widget.
2. Entering the **Latitude**, **Longitude** and **Altitude** values.

Make sure you select **Save Changes** at the bottom of the page.

{{< figure src="device-location.png" alt="Gateway location" >}}

{{< /tabs/tab >}}
Expand Down
4 changes: 2 additions & 2 deletions doc/content/gateways/concepts/adding-gateways/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,9 +222,9 @@ curl -H "Content-Type: application/json" -H "Authorization: Bearer $API_KEY" \

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

Once you have added your gateway to {{% tts %}}, you can also set its location to be displayed on a map widget by clicking **Change location settings**.
Once you have added your gateway to {{% tts %}}, you can also set its location to be displayed on a map widget by clicking **Location** in the left-hand menu.

If you do not mind your gateway's location to be publicly displayed, check the **Publish location** box.
If you do not mind your gateway's location to be publicly displayed, check the **Share location within network** box.

The gateway location can be manually set by entering the **Latitude**, **Longitude** and **Altitude** values.

Expand Down
Binary file modified doc/content/gateways/concepts/adding-gateways/gateway-add.png
Binary file modified doc/content/gateways/concepts/adding-gateways/gateway-claim.png
Binary file modified doc/content/gateways/concepts/adding-gateways/pb-forwarding.png
Binary file modified doc/content/gateways/concepts/lora-basics-station/lns-key.png
2 changes: 1 addition & 1 deletion doc/content/gateways/concepts/udp/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ An example `global_conf.json` is available in the [{{% udp-pf %}} Github reposit

## Download Configuration in the Console {#download-configuration-in-the-console}

To download a `global_conf.json` file for your gateway, open the Gateway overview page in the console. Click the **Download global_conf.json** button to download the file.
To download a `global_conf.json` file for your gateway, open the Gateway overview page in the console. Click the **Hamburger menu** in the top-right and then click **Download global_conf.json** to download the file.

{{< figure src="conf.png" alt="Download global_conf.json" >}}

Expand Down
Binary file modified doc/content/gateways/concepts/udp/conf.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file modified doc/content/integrations/mqtt/mqtt-integration.png
Binary file modified doc/content/integrations/mqtt/mqtt-key-created.png
Binary file modified doc/content/integrations/payload-formatters/application.png
Binary file modified doc/content/integrations/payload-formatters/device.png
Binary file modified doc/content/integrations/webhooks/add-webhook.png
Binary file modified doc/content/integrations/webhooks/api-key-created.png
Binary file modified doc/content/integrations/webhooks/api-key-creation.png
Binary file modified doc/content/integrations/webhooks/enabled-messages.png
4 changes: 1 addition & 3 deletions doc/content/integrations/webhooks/retries.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,9 @@ Webhook queuing allows individual HTTP requests to be retried at later times, wh

The webhook retries feature can be enabled on both new and existing webhooks via the Console, by ticking the **Retries** checkbox in the webhook settings:

{{< figure src="../webhook-queue-before.png" alt="Enabling webhook retries" >}}

After the checkbox has been ticked, and the webhook has been saved, future requests will be enqueued and retried on failure.

{{< figure src="../webhook-queue-after.png" alt="Webhook queueing enabled" >}}
{{< figure src="../webhook-retries.png" alt="Webhook queueing enabled" >}}

## What counts as a failed try ?

Expand Down
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file modified doc/content/integrations/webhooks/webhook-templates.png
Binary file modified doc/content/reference/components/console_overview.png
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,18 @@ Alert notifications are dispatched by {{% tts %}} using _alert notification rece

## Alert Notification Receivers

Alert notification receivers represent endpoints to which {{% tts %}} sends alert notifications. An endpoint in this case can be an email address, a phone number or an URL. The receivers can be managed via the Console, using the **Alerting** section of the **Admin Panel**.

{{< figure src="receivers-landing.png" alt="Alert Notification Receivers overview" >}}
Alert notification receivers represent endpoints to which {{% tts %}} sends alert notifications. An endpoint in this case can be an email address, a phone number or an URL. The receivers can be managed via the Console, using the **Alerting settings** section of the **Admin Panel**.

By clicking on **Add an alert receiver** one can create a new alert notification receiver. Fill in the details and click on **Save changes** in order to save your newly created receiver.

{{< figure src="add-receiver.png" alt="Add Alert Notification Receiver" >}}
{{< figure src="receiver.png" alt="Add Alert Notification Receiver" >}}

## Alert Notification Profiles

Once the alert notifications receivers are setup, we can create alert notification profiles. Alert notification profiles are bundles of alert notification receivers which can be attached to entities in order to dispatch alert notifications to multiple endpoints. It is also possible to set a default alert notification profile which is used for entities without an explicit profile set.

The profiles can be managed also via the Console, by switching to the the **Alert Profiles** tab in the **Alerting** section of the **Admin Panel**.

{{< figure src="profiles-landing.png" alt="Alert Notification Profiles overview" >}}
The profiles can be managed also via the Console, by switching to the the **Alert Profiles** tab in the **Alerting settings** section of the **Admin Panel**.

By clicking on *Add an alert profile** one can create a new alert notification profile. Fill in the details and click on **Save changes** in order to save your newly created profile. It is also possible to mark this profile as the default profile in this page.
By clicking on **Add an alert profile** one can create a new alert notification profile. Fill in the details and click on **Save changes** in order to save your newly created profile. It is also possible to mark this profile as the default profile in this page.

{{< figure src="add-profile.png" alt="Add Alert Notification Profile" >}}
{{< figure src="profile.png" alt="Add Alert Notification Profile" >}}
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file modified doc/content/the-things-stack/interact/console/console.png
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ On the Console landing page, click **Login with your {{% tts %}} Account** in or

{{< figure src="login.png" alt="Login" >}}

If you do not have an account yet, you can register one by clicking **Create an account**, filling your details and clicking **Register**.
If you do not have an account yet, you can register one by clicking **Login using credentials** and then **Create an account**. Then fill in your details and click **Create account**.

{{< figure src="register.png" alt="Create an account" >}}

When you use a new account, you may not be able to continue until you have confirmed your email address or your account is approved by an admin user.

After entering your credentials and logging in, you will reach the Console overview page.
After entering your credentials and logging in, you will reach the Console Home page.

{{< figure src="overview.png" alt="Overview" >}}
Binary file modified doc/content/the-things-stack/interact/console/login/login.png
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For this screen you can click through to Login using credentials and make the screenshot there, since that login mode is the most common.

Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Click **Save changes** to save any modified info.

### Change password

To set up a new password for your account, click the **Expand** button next to the **Change password** section.
To set up a new password for your account, click **Password** in the left-hand sidebar.

Type in your **Current password**, then create a **New password** and confirm it. We highly recommend you create a strong password to enhance your profile's security.

Expand All @@ -51,7 +51,7 @@ In this section, we explain how to create personal API keys that grant certain r

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

To create a personal API key, click on your avatar in the upper right corner in the Console and select **Personal API keys**.
To create a personal API key, click on **User settings** in the left-hand sidebar and select **API keys**.

Enter a **Name** for your key, set the **Expiry date**, select rights that you want to grant and then press **Create API Key**.

Expand Down
Binary file modified doc/content/the-things-stack/management/purge/delete.png
Binary file modified doc/content/the-things-stack/management/purge/purge.png
Binary file modified doc/content/the-things-stack/management/purge/restore-app.png
Binary file modified doc/content/the-things-stack/management/sso/login-screen.png
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To manage organizations, click the **Organizations** tab in the top menu.

{{< figure src="orgs.png" alt="Organizations" >}}

To add an organization, click **Add organization**.
To add an organization, click **Create organization**.

{{< figure src="add-org.png" alt="Add organization" >}}

Expand All @@ -34,7 +34,9 @@ Use the left hand menu in your organization's settings to add or remove collabor

### Create Organization API Key

When a user is a member of an organization which is a collaborator for an entity, the user's rights are the intersection of the user's rights in the organization and the organization's rights on the entity. To grant rights to your organization, navigate to **API Keys** on the left hand menu of your organization's settings and select **Add API Key**.
When a user is a member of an organization which is a collaborator for an entity, the user's rights are the intersection of the user's rights in the organization and the organization's rights on the entity. To grant rights to your organization, navigate to **API Keys** on the top hand menu of your organization's settings and select **Add API Key**.

{{< figure src="organization-api-keys.png" alt="Application API Key" >}}

Enter a **Name** for your key, set the **Expiry date**, select rights that you want to grant and then press **Create API Key**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Packet Broker can be configured using either the Console or the CLI.

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

To configure Packet Broker, click the **Packet Broker** button in the top right menu.
To configure Packet Broker, click on **Admin panel** in the left-hand menu and select **Packet Broker**.

{{< figure src="pb-menu.png" alt="Packet Broker Menu Button" >}}

Expand Down
Diff not rendered.
Loading