docs(helm): Add recommended post-installation configuration guide

[roboav8r]

Rationale

Updating the helm documentation following a recent customer deployment who enabled dedicated plugins and delegated operators (our recommended best practice). This is not currently explicitly stated in the documentation.

Review Priority

• high
• medium
• low

Changes

• New doc helm/docs/post-install-recommended-configuration.md: a
  step-by-step guide covering dedicated plugins mode, delegated operators
  (always-on and on-demand), optional GPU scheduling, and a plugin quickstart.
  Links to the existing deep-dive docs rather than duplicating them.
• helm/README.md: new ## Recommended Next Steps section at the end with a
  motivation paragraph and a three-row summary table (dedicated plugins,
  delegated operators, on-demand orchestrator), linking to the new doc.
• helm/fiftyone-teams-app/README.md.gotmpl: new ## Recommended Next Steps
  section immediately after the helm install command, with the same link.
  README.md regenerated via helm-docs.
• helm/values.yaml: added a comment above the commented-out
  delegatedOperatorDeployments and pluginsSettings blocks pointing to the new
  doc.

Checklist

• This PR maintains parity between Docker Compose and Helm

Testing

Documentation-only change. Verified:

• All relative links in the new doc resolve correctly from helm/docs/ (./plugins-storage.md, ./configuring-delegated-operators.md, ./configuring-gpu-workloads.md, ../../docs/configuring-on-demand-orchestrator.md)
• helm-docs pre-commit hook passes cleanly on the updated .gotmpl
• TOC in helm/README.md matches the actual heading structure

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b6967d52-a5ee-4c9e-bbcf-8dafa63ce675

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

Walkthrough

This pull request adds production-oriented post-install documentation for FiftyOne Enterprise Helm deployments. It introduces a comprehensive guide detailing configuration steps for shared storage prerequisites, dedicated plugins, delegated operator workers, GPU workloads, and plugin registration, along with verification steps.

Changes

Cohort / File(s)	Summary
Root Documentation helm/README.md, helm/docs/post-install-recommended-configuration.md	Adds a new "Recommended Next Steps" section to the Helm README and introduces a comprehensive post-install configuration guide covering shared storage setup, dedicated plugins, delegated operators, GPU workloads, orchestrator registration, priority class configuration, and plugin verification.
Helm Chart Documentation helm/fiftyone-teams-app/README.md, helm/fiftyone-teams-app/README.md.gotmpl	Updates both the static and templated chart README files with a clarification of default deployment capabilities (builtin plugins only, no delegated workers) and directs users to the post-install configuration guide for next steps.

Estimated Code Review Effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

---

🐰 A hop through docs so fine and clear,
Post-install steps now drawing near,
With plugins, workers, storage, GPU grace,
Enterprise deployments find their place!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: adding a post-installation configuration guide to Helm documentation, which aligns with the primary objective of the PR.
Description check	✅ Passed	The description includes all key sections from the template (Rationale, Changes, Testing, priority) with detailed explanations of the new documentation files and changes made. However, the Docker Compose parity checklist item is explicitly left unchecked without explanation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch add-helm-post-install

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

helm/docs/post-install-recommended-configuration.md (1)

214-215: Normalize orchestrator naming in examples.

teamsDoGpu vs teamsDocpu casing is inconsistent; use a consistent style (e.g., teamsDoCpu) to reduce copy/paste errors.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@helm/docs/post-install-recommended-configuration.md` around lines 214 - 215,
The example uses inconsistent casing for the orchestrator flag (teamsDoGpu vs
teamsDocpu); rename the symbol to a consistent form such as teamsDoCpu across
the docs and examples — update the YAML key shown (teamsDocpu -> teamsDoCpu),
any other occurrences of teamsDocpu and teamsDoGpu to teamsDoCpu, and ensure
related references (replicaCount usage, README examples) match the new name to
avoid copy/paste errors.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@helm/docs/post-install-recommended-configuration.md`:
- Around line 98-100: Update the text string that reads "builtin operators" to
use the hyphenated form "built-in operators" for consistency; locate the
sentence referencing the `teamsDo` pod (the line containing "The `teamsDo` pod
will only be able to execute builtin operators.") and replace "builtin
operators" with "built-in operators".

---

Nitpick comments:
In `@helm/docs/post-install-recommended-configuration.md`:
- Around line 214-215: The example uses inconsistent casing for the orchestrator
flag (teamsDoGpu vs teamsDocpu); rename the symbol to a consistent form such as
teamsDoCpu across the docs and examples — update the YAML key shown (teamsDocpu
-> teamsDoCpu), any other occurrences of teamsDocpu and teamsDoGpu to
teamsDoCpu, and ensure related references (replicaCount usage, README examples)
match the new name to avoid copy/paste errors.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f96a2e8e-9af2-4de0-b9cf-136bdda797ba

📥 Commits

Reviewing files that changed from the base of the PR and between 157711a and 5abe3f8.

⛔ Files ignored due to path filters (1)

• helm/values.yaml is excluded by !**/*.yaml

📒 Files selected for processing (4)

• helm/README.md
• helm/docs/post-install-recommended-configuration.md
• helm/fiftyone-teams-app/README.md
• helm/fiftyone-teams-app/README.md.gotmpl

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Use “built-in” for consistency/readability.

Line 100 should use “built-in operators” instead of “builtin operators”.

🧰 Tools

🪛 LanguageTool

[grammar] ~100-~100: Ensure spelling is correct
Context: ...sDo` pod will only be able to > execute builtin operators. To enable delegated operato...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@helm/docs/post-install-recommended-configuration.md` around lines 98 - 100,
Update the text string that reads "builtin operators" to use the hyphenated form
"built-in operators" for consistency; locate the sentence referencing the
`teamsDo` pod (the line containing "The `teamsDo` pod will only be able to
execute builtin operators.") and replace "builtin operators" with "built-in
operators".

[kevin-dimichel]

I thought the intention here was to update the docs so that we suggested a deployment with dedicated plugins and delegated operators? If that's the case, should we move the content from this new helm/docs/post-install-recommended-configuration.md file into the main README.md?

[roboav8r]

I would like to keep it in a separate post-install-recommended-configuration.md for a couple of reasons:

• Keeping the length of the README manageable
• Keeping the deployment process modular. I think it helps to get the initial deployment done and working, and then introduce the more advanced concepts of dedicated plugins and DOs.

[kevin-dimichel]

We are creating divergence in our approach in docker compose (install with dedicated plugins and DOs [added in https://github.com//pull/583]) and now making that a post-install step for helm.

Is this the right choice?

I feel that we should be prescriptive about the typical default deployment we want to promote (#moreCompute).

By the time someone sees this doc, they've already performed the installation and we are requesting they go back and re-configure. Why not just have them configure it once, the suggested way?

[roboav8r]

Made suggested changes to line length and removed reference to built-in plugins.

[kevin-dimichel]

I still believe that we should incorporate these recommended configurations into the initial docs and not have a separate doc, but I'll approve anyway.

The base branch was changed.