feat: Requeue DO environment var documentation [FOEPD-2878]

[CamronStaley]

Rationale

https://voxel51.atlassian.net/browse/FOEPD-2878

This voxel-hub pr introduces the concept of "requeueing" stuck operations so I am documenting the new environment vars here to reflect those: https://github.com/voxel51/voxel-hub/pull/2017

Changes

Add two new env vars for requeuing stuck DOs

Checklist

• This PR maintains parity between Docker Compose and Helm

Testing

Automated tests + testing on that other PR

Notes

This feature will be released in the next release. Once the release branch is made, we will update the target branch.

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

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

Walkthrough

Documentation and test coverage added for two new environment variables controlling operation requeueing behavior: FIFTYONE_DO_REQUEUE_DELAY_MINUTES (30-minute default) and FIFTYONE_DO_REQUEUE_MAX_ATTEMPTS (3 attempts default). Updates span Docker README, Helm configuration documentation, and unit tests.

Changes

Cohort / File(s)	Summary
Documentation – Docker docker/README.md	Added FIFTYONE_DO_REQUEUE_DELAY_MINUTES and FIFTYONE_DO_REQUEUE_MAX_ATTEMPTS to Environment Variables table with descriptions and required status.
Documentation – Helm helm/fiftyone-teams-app/README.md	Added apiSettings.env.FIFTYONE_DO_REQUEUE_DELAY_MINUTES and apiSettings.env.FIFTYONE_DO_REQUEUE_MAX_ATTEMPTS to configuration values with type, default values, and behavior documentation.
Tests – Helm Deployment tests/unit/helm/api-deployment_test.go	Inserted new environment variables with values "30" and "3" respectively into multiple TestContainerEnv test scenarios.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Two new settings hop into place,
Requeue delays and attempts to embrace,
Docs and tests now aligned with care,
Operations queued beyond compare!

🚥 Pre-merge checks | ✅ 3

✅ 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.
Description check	✅ Passed	The pull request description includes all required sections from the template with substantive content: rationale with Jira ticket and reference to related PR, clear description of changes, the parity checklist item checked, and testing details provided.
Title check	✅ Passed	The title accurately summarizes the main change: documentation of two new requeue-related environment variables, which aligns with the changeset covering Docker, Helm, and test documentation updates.

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

---

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

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In @docker/README.md:
- Line 831: Fix the typo in the README table for the environment variable
FIFTYONE_DO_REQUEUE_DELAY_MINUTES: change the description text from "requeud" to
"requeued" so the sentence reads "The number of minutes an operation can sit in
queued before being requeued. Default is 30 minutes."

In @helm/fiftyone-teams-app/README.md:
- Line 690: Update the README table entry for
apiSettings.env.FIFTYONE_DO_REQUEUE_DELAY_MINUTES to correct the typo: change
"requeud" to "requeued" so the description reads "The number of minutes an
operation can sit in queued before being requeued."

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5c43095 and 295c6a9.

⛔ Files ignored due to path filters (2)

• helm/fiftyone-teams-app/values.schema.json is excluded by !**/*.json
• helm/fiftyone-teams-app/values.yaml is excluded by !**/*.yaml

📒 Files selected for processing (3)

• docker/README.md
• helm/fiftyone-teams-app/README.md
• tests/unit/helm/api-deployment_test.go

🧰 Additional context used

🪛 LanguageTool

docker/README.md

[grammar] ~831-~831: Ensure spelling is correct
Context: ...peration can sit in queued before being requeud. Default is 30 minutes. ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: helm-integration / integration-helm
• GitHub Check: helm-unit / unit-helm
• GitHub Check: pre-commit
• GitHub Check: docker-pulls

🔇 Additional comments (1)

tests/unit/helm/api-deployment_test.go (1)

497-504: LGTM! Test coverage is comprehensive.

The new environment variables are correctly added to all test scenarios with consistent default values ("30" and "3"), ensuring proper validation across different configurations.

Also applies to: 603-610, 723-730, 840-847, 945-952, 1050-1057

[kevin-dimichel]

@CamronStaley - the other test indentation issues are fixed in #492

[swheaton]

🚢 🇮🇹