Sid/edit docker docs

[sherpan]

Rationale

Docs change to improve the end-user experience for customers who want to install docker via FOE

Review Priority

• high
• medium
• low

Changes

Checklist

• This PR maintains parity between Docker Compose and Helm

Testing

[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: fcc3fa5d-eba8-42b0-9803-5466d3a98b95

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 PR updates the Docker deployment documentation with restructured step numbering and guidance. It adds foundational MongoDB setup instructions, reorganizes environment configuration, clarifies that Dedicated Plugins and Delegated Operators are enabled by default, simplifies Nginx configuration, introduces delegated operation logging configuration, and replaces upgrade guidance with new advanced DO settings and a refreshed upgrade procedure.

Changes

Deployment Guide Restructuring

Layer / File(s)	Summary
Table of contents and step numbering docker/README.md	Updated table of contents to reflect new Step 0 (MongoDB) through Step 6 (IdP/CAS) numbering, and renumbered section headings to remove prior authentication-mode and plugin-configuration navigation entries.
MongoDB and environment configuration (Steps 0–2) docker/README.md	Added Step 0 describing supported MongoDB editions and instructing users to record the connection URI, then reorganized Step 2 to direct users into the internal-auth directory before configuring the .env file.
Initial deployment defaults (Step 3) docker/README.md	Updated initial deployment content to state that Dedicated Plugins and Delegated Operators are enabled by default, and changed the docker compose example to include compose.dedicated-plugins.yaml.
Reverse proxy and delegated operation logs (Steps 4–5) docker/README.md	Simplified Nginx configuration to a single hostname with path-based routing reference, and added Step 5 for delegated operation log path configuration via compose overrides with path format example.
Advanced settings and upgrade procedures docker/README.md	Replaced prior upgrade guidance with new Advanced DO Settings subsections covering GPU workloads, custom plugin images, and on-demand executors, followed by an updated Upgrades procedure describing version pulling, custom plugin image rebuilds, and down/up restart workflow.

🎯 2 (Simple) | ⏱️ ~12 minutes

🐰 The Docker guide now hops through steps with clarity,
MongoDB first, then configs light,
Plugins enabled, reverse proxies bright—
Advanced settings in sight,
All upgraded in one fluffy commit! 🚀

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is largely incomplete: it omits detailed change descriptions, provides no testing information, leaves the Docker Compose/Helm parity checkbox unchecked without explanation, and lacks additional context despite the substantial documentation restructuring.	Expand the description with specific change details, explain testing approach, clarify parity checkbox status, and address any breaking changes or migration considerations for existing users.
Title check	❓ Inconclusive	The title 'Sid/edit docker docs' is vague and does not clearly describe the main changes; it reads as a branch name rather than a descriptive summary of the documentation updates.	Revise the title to be more descriptive of the actual changes, such as 'Reorganize Docker deployment documentation with simplified steps and updated defaults' to clearly convey the documentation restructuring.

✅ Passed checks (3 passed)

Check name	Status	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 sid/edit_docker_docs

---

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.}

[coderabbitai]

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docker/README.md (1)

251-263: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix the FIFTYONE_DATABASE_ADMIN contradiction in initial setup.

Line 251 says to enable DB admin mode, but Line 259 sets it to false, and Line 262 says it allows schema creation/migration. This is internally inconsistent and can break first-time install guidance.

Suggested doc fix

 ### 1. Enable Database Admin mode

 In `compose.override.yaml`, make sure:

 ```yaml
 services:
   fiftyone-app:
     environment:
-      FIFTYONE_DATABASE_ADMIN: false
+      FIFTYONE_DATABASE_ADMIN: true

Then keep `false` in the upgrade section where you already correctly require it.
</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @docker/README.md around lines 251 - 263, The README's initial setup
contradicts itself by telling users to "Enable Database Admin mode" but showing
FIFTYONE_DATABASE_ADMIN: false; update the compose.override.yaml example under
"1. Enable Database Admin mode" to set FIFTYONE_DATABASE_ADMIN: true so the app
can create/migrate the schema, and leave the FIFTYONE_DATABASE_ADMIN: false
value only in the upgrade section as currently documented; specifically edit the
environment value for FIFTYONE_DATABASE_ADMIN in the compose.override.yaml
example referenced in this section.

</details>

</blockquote></details>

</blockquote></details>

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docker/README.md`:
- Around line 407-408: Replace the incorrect noun "setup" with the verb phrase
"set up" in the sentence that currently reads "To setup containers with GPU
resources, see the [configuring GPU workloads
documentation](./docs/configuring-gpu-workloads.md)." — update that string to
"To set up containers with GPU resources, see the [configuring GPU workloads
documentation](./docs/configuring-gpu-workloads.md)." ensuring only the wording
is changed and the link remains intact.
- Around line 349-358: The docs currently use two different environment variable
names—FIFTYONE_DELEGATED_OPERATION_LOG_PATH (in Step 5) and
FIFTYONE_DELEGATED_OPERATION_RUN_LINK_PATH (in the Environment Variables
table)—which will confuse users; unify them by choosing the intended variable
name (e.g., FIFTYONE_DELEGATED_OPERATION_LOG_PATH) and update every occurrence:
change the Environment Variables table entry for
FIFTYONE_DELEGATED_OPERATION_RUN_LINK_PATH to the chosen name, update any
examples or references that mention the alternate symbol, and ensure the
description/documentation of FIFTYONE_DELEGATED_OPERATION_LOG_PATH matches the
usage shown in Step 5.

---

Outside diff comments:
In `@docker/README.md`:
- Around line 251-263: The README's initial setup contradicts itself by telling
users to "Enable Database Admin mode" but showing FIFTYONE_DATABASE_ADMIN:
false; update the compose.override.yaml example under "1. Enable Database Admin
mode" to set FIFTYONE_DATABASE_ADMIN: true so the app can create/migrate the
schema, and leave the FIFTYONE_DATABASE_ADMIN: false value only in the upgrade
section as currently documented; specifically edit the environment value for
FIFTYONE_DATABASE_ADMIN in the compose.override.yaml example referenced in this
section.

🪄 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: d96e121c-b6ac-4b74-9f4e-2c0f83513299

📥 Commits

Reviewing files that changed from the base of the PR and between 816edea and 4831ff1.

📒 Files selected for processing (1)

• docker/README.md

[kevin-dimichel]

Yes. But let's not call it an end-to-end when it isn't : D

Please update.

[kevin-dimichel]

Almost there! After these, we can approve.