Skip to content

Commit 48d2eaf

Browse files
committed
Tweak docs
1 parent 9e288fa commit 48d2eaf

3 files changed

Lines changed: 11 additions & 6 deletions

File tree

docs/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Docs
2+
3+
- [Deployment (with examples)](deployment/)
4+
- [Behavior in combination with ShinyProxy](shinyproxy.md)
5+
- [Prometheus monitoring](prometheus.md)

docs/prometheus.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Before diving into the details, have a look at the setup of Prometheus
99
monitoring with ShinyProxy in a [regular deployment](https://shinyproxy.io/documentation/usage-statistics/#micrometer).
1010

1111
Because the operator is meant to dynamically create ShinyProxy servers, it does
12-
not suffice to configure static list of ShinyProxy servers in Prometheus.
13-
Fortunately, Prometheus has the concept of [Service Discover](https://prometheus.io/docs/prometheus/latest/configuration/configuration/),
12+
not suffice to configure a static list of ShinyProxy servers in Prometheus.
13+
Fortunately, Prometheus has the concept of [Service Discovery](https://prometheus.io/docs/prometheus/latest/configuration/configuration/),
1414
which allows Prometheus to automatically *discover* ShinyProxy servers. We
1515
assume here that Prometheus is running in the same Kubernetes cluster as the
1616
ShinyProxy operator.
1717

18-
What follows is an example configuration of Prometheus:
18+
Example Prometheus configuration:
1919

2020
```yaml
2121
scrape_configs:

docs/shinyproxy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ latest server.
3434
the latest version.
3535
- a message on the main page of ShinyProxy is shown:
3636

37-
![Message on the app page](../../.github/screenshots/message_main_page.png)
37+
![Message on the app page](../.github/screenshots/message_main_page.png)
3838

3939
- a message on the app page of ShinyProxy is shown:
4040

41-
![Message on the app page](../../.github/screenshots/message_app_page.png)
41+
![Message on the app page](../.github/screenshots/message_app_page.png)
4242

4343
- after clicking the button on the message the user is transferred to the latest
4444
ShinyProxy server
@@ -97,7 +97,7 @@ server. This server will then redirect to the OpenID provider.
9797
the latest ShinyProxy server
9898

9999
**Note:** this only works when the `proxy.operator.force-transfer` option is set
100-
to `true` (in the ShinyProxy configuration).
100+
to `true` (in the ShinyProxy configuration). By default this option is disabled.
101101

102102
### Scenario 5: Starting an app
103103

0 commit comments

Comments
 (0)