Skip to content

Commit 8aa0a3c

Browse files
committed
chore(pre-commit): AS-706 update markdown lint findings
1 parent 79e5743 commit 8aa0a3c

4 files changed

Lines changed: 22 additions & 21 deletions

File tree

.markdownlint.yaml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,3 @@ default: true
44
MD013: # Line Length
55
code_blocks: false
66
tables: false
7-
8-
# MD059/descriptive-link-text Link text should be descriptive
9-
# This rule marks things like:
10-
# `Example nginx configurations can be found [here](../)`
11-
# as errors.
12-
# The context comes before the link so this seems
13-
# like a fair rule to disable.
14-
MD059: false

docker/README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -161,14 +161,24 @@ The FiftyOne Enterprise App is exposed on port `3000`.
161161
The FiftyOne Enterprise CAS is exposed on port `3030`.
162162

163163
Configure an SSL endpoint (like a Load Balancer, Nginx Proxy, or similar)
164-
to route traffic to the appropriate endpoints. An example Nginx configuration
165-
for path-based routing can be found
166-
[here](./example-nginx-path-routing.conf).
167-
Example Nginx configurations for hostname-based routing can be found
168-
[here](./example-nginx-site.conf)
169-
for FiftyOne Enterprise App and FiftyOne Enterprise CAS services, and
170-
[here](./example-nginx-api.conf)
171-
for the FiftyOne Enterprise API service.
164+
to route traffic to the appropriate endpoints.
165+
166+
FiftyOne Enterprise can be routed via two main patterns:
167+
168+
1. Path-Based Routing:
169+
In this pattern, all services
170+
(including the FiftyOne Enterprise App, CAS, and API)
171+
are hosted behind a single DNS endpoint.
172+
Voxel51 providdes an
173+
[example nginx configuration](./example-nginx-path-routing.conf)
174+
for this pattern.
175+
176+
1. Hostname-Based Routing:
177+
A pattern where the FiftyOne Enterprise API has a separate DNS
178+
name to separate API traffic from other FiftyOne Enterprise Applications.
179+
Voxel51 provides separate Nginx configurations for:
180+
1. [FiftyOne Enterprise App and FiftyOne Enterprise CAS services](./example-nginx-site.conf)
181+
1. [FiftyOne Enterprise API service](./example-nginx-api.conf).
172182

173183
## Upgrades
174184

@@ -475,7 +485,7 @@ follow
475485
| `FIFTYONE_APP_PRIVACY_URL` | Privacy URL used in App | No |
476486
| `FIFTYONE_APP_IMPRINT_URL` | Imprint URL used in App | No |
477487
| `FIFTYONE_APP_TEAMS_SDK_RECOMMENDED_VERSION` | The recommended fiftyone SDK version. This will be displayed in install modal (i.e. `pip install ... fiftyone==0.11.0`) | No |
478-
| `FIFTYONE_APP_THEME` | The default theme configuration for your FiftyOne Enterprise application as described [here](https://docs.voxel51.com/user_guide/config.html#configuring-the-app) | No |
488+
| `FIFTYONE_APP_THEME` | The default theme configuration for your FiftyOne Enterprise application as described [in our documentation](https://docs.voxel51.com/user_guide/config.html#configuring-the-app) | No |
479489
| `FIFTYONE_APP_DEFAULT_QUERY_PERFORMANCE` | Controls whether Query Performance mode is enabled by default for every dataset for the application. Set to false to set default mode to off. | No |
480490
| `FIFTYONE_APP_ENABLE_QUERY_PERFORMANCE` | Controls whether Query Performance mode is enabled for the application. Set to false to disable Query Performance mode for entire application. | No |
481491
| `FIFTYONE_API_URI` | The URI to be displayed in the `Install FiftyOne` Modal and `API Keys` configuration screens | No |

docker/docs/upgrading.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -359,8 +359,7 @@ Additionally,
359359

360360
1. Update your web server routes to include routing
361361
`/cas/*` traffic to the `teams-cas` service.
362-
Example nginx configurations can be found
363-
[here](../)
362+
Please see our [example nginx configurations](../) for more information.
364363
1. [Upgrade to FiftyOne Enterprise v2.9.0](#upgrading-from-previous-versions)
365364
with `FIFTYONE_DATABASE_ADMIN=true`
366365
(this is not the default for this release).

helm/docs/upgrading.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ the
4444
[Helm Chart](https://github.com/voxel51/fiftyone-teams-app-deploy)
4545
and update your deployment accordingly.
4646

47-
A minimal example `values.yaml` may be found
48-
[here](../values.yaml).
47+
Voxel51 provides a
48+
[minimum example `values.yaml`](../values.yaml).
4949

5050
1. Edit the `values.yaml` file
5151
1. To upgrade an existing helm installation

0 commit comments

Comments
 (0)