Skip to content

Commit

Permalink
UI Documentation: feedback from review
Browse files Browse the repository at this point in the history
- remove trade mark
- change order in sidebar
- make links to online sandbox work

Signed-off-by: thfries <thomas.fries0@gmail.com>
  • Loading branch information
thfries committed Oct 12, 2022
1 parent 144d31e commit 159f27a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -758,14 +758,15 @@ entries:
- title: → Search examples
url: /protocol-examples-search.html
output: web
- title: Sandbox
url: /sandbox.html
output: web

- title: User Interface
url: /user-interface.html
output: web

- title: Sandbox
url: /sandbox.html
output: web

- title: Presentations
url: /presentations.html
output: web
Expand Down
18 changes: 9 additions & 9 deletions documentation/src/main/resources/pages/ditto/user-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ topnav: topnav

There is a browser based user interface to explore things, policies and connections.
The UI can be used to access the REST API of any Ditto instance.
Several Ditto instances can be configured as "Environments"
Several Ditto instances can be configured as "Environments"

{% include image.html file="pages/ui/screenshot_introduction.png" alt="UI example screenshot" caption="Ditto Explorer UI" max-width=800 url="https://eclipse.github.io/ditto/index.html?primaryEnvironmentname=ditto_sandbox" %}
{% include image.html file="pages/ui/screenshot_introduction.png" alt="UI example screenshot" caption="Ditto Explorer UI" max-width=800 url="https://eclipse.github.io/ditto/index.html?primaryEnvironmentName=ditto_sandbox" %}


## How to use

The latest version of the Explorer UI is available online [here](https://eclipse.github.io/ditto/index.html?primaryEnvironmentname=ditto_sandbox)
The latest version of the Explorer UI is available online [here](https://eclipse.github.io/ditto/index.html?primaryEnvironmentName=ditto_sandbox){:target="_blank"}

There is also a Docker image prepared to server the latest version by docker:
```bash
Expand All @@ -29,16 +29,16 @@ docker run -p 8088:8080 eclipse/ditto-ui:nightly
```

## Environments
You can use the Explorer UI with different Ditto instances and switch easily between them.
You can use the Explorer UI with different Ditto instances and switch easily between them.

For example you can work with your **local running Ditto instance** and the remote Eclipse Ditto **sandbox instance**.
Another example would be to use different stages of Ditto like **development**, **test** and **production**.
For example you can work with your **local running Ditto instance** and the remote Eclipse Ditto **sandbox instance**.
Another example would be to use different stages of Ditto like **development**, **test** and **production**.

### Create a new environment
To create a new environment you just need to specify
* a unique name
* the api URI to reach Ditto
* whether it is a Ditto 2 or Ditto 3 version (only relevant if you want to use the connectivity API of Ditto prior to version 3)
* the api URI to reach Ditto
* whether it is a Ditto 2 or Ditto 3 version (only relevant if you want to use the connectivity API of Ditto prior to version 3)

{% include image.html file="pages/ui/screenshot_add_environment.png" alt="Screenshot how to add an environment" caption="Create a new environment" max-width=800 %}

Expand All @@ -56,4 +56,4 @@ The following query parameters can be used to control environments
| `environmentsURL` | URL to a json file with environment configurations |

## Authorization
To access the REST API of your selected Ditto instance you must provide valid credentials by clicking on "Authorize"
To access the REST API of your selected Ditto instance you must provide valid credentials by clicking on "Authorize"

0 comments on commit 159f27a

Please sign in to comment.