Skip to content

Commit 87244ed

Browse files
committed
docs(helm): Address review feedback on post-install guide
1 parent bd44b2b commit 87244ed

4 files changed

Lines changed: 22 additions & 23 deletions

File tree

helm/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -283,10 +283,10 @@ FiftyOne Enterprise installation at the DNS address you created
283283

284284
## Recommended Next Steps
285285

286-
The base `helm install` above starts FiftyOne Enterprise with **builtin-only
287-
plugins** and **no delegated operator workers**. While this is sufficient to
288-
get started, we strongly recommend enabling the following features for a
289-
production-ready deployment:
286+
The base `helm install` above starts FiftyOne Enterprise with **built-in only
287+
plugins** and **no delegated operator workers**. While sufficient to get
288+
started, we recommend enabling the following features for a production-ready
289+
deployment:
290290

291291
| Step | What it enables |
292292
| --- | --- |

helm/docs/post-install-recommended-configuration.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Recommended Post-Installation Configuration
22

3-
After completing the base Helm installation, we strongly recommend enabling the
3+
After completing the base Helm installation, we recommend enabling the
44
following features for a production-ready FiftyOne Enterprise deployment:
55

66
1. [Dedicated Plugins Mode](#dedicated-plugins-mode)
77
1. [Delegated Operators](#delegated-operators)
88
1. [GPU Workloads (Optional)](#gpu-workloads-optional)
99

10-
The default installation uses **builtin-only plugins** and has **no delegated
11-
operator workers**. While this is sufficient to get started, it limits the
12-
ability to install custom plugins and run long-running or compute-heavy tasks
13-
in the background.
10+
The default installation uses **built-in plugins** and has **no delegated
11+
operator workers**. While sufficient to get started, it limits the ability to
12+
install custom plugins and tasks (run long-running or compute-heavy) in the
13+
background.
1414

1515
> **Note:** Steps 1 and 2 require shared storage (a PersistentVolumeClaim).
1616
> See [Prerequisites](#prerequisites-shared-storage) before proceeding.
@@ -35,7 +35,7 @@ The examples below assume:
3535

3636
## Dedicated Plugins Mode
3737

38-
By default, plugins run inside the `fiftyone-app` pod (builtin-only mode).
38+
By default, plugins run inside the `fiftyone-app` pod (built-in only mode).
3939
We recommend enabling **dedicated plugins mode**, which runs plugins in their
4040
own `teams-plugins` pod. This provides:
4141

@@ -51,7 +51,7 @@ There are three plugin modes available:
5151

5252
| Mode | Description |
5353
| --- | --- |
54-
| Builtin Only (default) | Only builtin plugins shipped with FiftyOne Enterprise |
54+
| Built-in Only (default) | Only built-in plugins shipped with FiftyOne Enterprise |
5555
| Shared | Custom plugins run inside `fiftyone-app` — may starve the app |
5656
| **Dedicated (recommended)** | Custom plugins run in a dedicated `teams-plugins` pod |
5757

@@ -96,9 +96,9 @@ computing embeddings, running model evaluations, importing datasets, or
9696
annotation workflows — to be scheduled from the FiftyOne UI and executed in
9797
the background on dedicated compute workers.
9898

99-
> **Note:** If you are using builtin-only plugin mode, omit the PVC volume
99+
> **Note:** If you are using built-in only plugin mode, omit the PVC volume
100100
> mount from the configuration below. The `teamsDo` pod will only be able to
101-
> execute builtin operators.
101+
> execute built-in operators.
102102
103103
To enable delegated operators with dedicated plugins, add the following to
104104
your `values.yaml`:
@@ -212,7 +212,7 @@ delegatedOperatorDeployments:
212212
- name: plugins-vol
213213
mountPath: /opt/plugins
214214

215-
teamsDocpu:
215+
teamsDoCpu:
216216
replicaCount: 2
217217
env:
218218
FIFTYONE_PLUGINS_DIR: /opt/plugins
@@ -276,7 +276,7 @@ Once dedicated plugins are enabled, you can install community plugins from the
276276
[FiftyOne Plugin Library](https://github.com/voxel51/fiftyone-plugins) or
277277
the [FiftyOne Docs](https://docs.voxel51.com/plugins/index.html).
278278

279-
Some recommended plugins to get started:
279+
We recommend starting with these plugins:
280280

281281
- [`@voxel51/brain`](https://github.com/voxel51/fiftyone-plugins/tree/main/plugins/brain)
282282
— compute embeddings and similarity indexes
@@ -287,6 +287,5 @@ Some recommended plugins to get started:
287287
- [`@voxel51/zoo`](https://github.com/voxel51/fiftyone-plugins/tree/main/plugins/zoo)
288288
— access the FiftyOne Model Zoo
289289

290-
To use plugins with custom dependencies (e.g. `torch`, `transformers`), build
291-
and use
290+
To use plugins with custom dependencies (e.g. `transformers`), build and use
292291
[Custom Plugin Images](https://github.com/voxel51/fiftyone-teams-app-deploy/blob/main/docs/custom-plugins.md).

helm/fiftyone-teams-app/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -343,10 +343,10 @@ A minimal example `values.yaml` may be found
343343

344344
## Recommended Next Steps
345345

346-
The base installation enables FiftyOne Enterprise with builtin plugins only
346+
The base installation enables FiftyOne Enterprise with built-in plugins only
347347
and no delegated operator workers. For a production-ready deployment, we
348-
strongly recommend enabling **dedicated plugins** and **delegated operators**
349-
after completing the install above.
348+
recommend enabling **dedicated plugins** and **delegated operators** after
349+
completing the install above.
350350

351351
See [Recommended Post-Installation Configuration](../docs/post-install-recommended-configuration.md)
352352
for step-by-step instructions.

helm/fiftyone-teams-app/README.md.gotmpl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -343,10 +343,10 @@ A minimal example `values.yaml` may be found
343343

344344
## Recommended Next Steps
345345

346-
The base installation enables FiftyOne Enterprise with builtin plugins only
346+
The base installation enables FiftyOne Enterprise with built-in plugins only
347347
and no delegated operator workers. For a production-ready deployment, we
348-
strongly recommend enabling **dedicated plugins** and **delegated operators**
349-
after completing the install above.
348+
recommend enabling **dedicated plugins** and **delegated operators** after
349+
completing the install above.
350350

351351
See [Recommended Post-Installation Configuration](../docs/post-install-recommended-configuration.md)
352352
for step-by-step instructions.

0 commit comments

Comments
 (0)