Update docs to mention builtin orchestrator

CamronStaley commented 1 week ago

What changes are proposed in this pull request?

What areas of FiftyOne does this PR affect?

[ ] App: FiftyOne application changes
[ ] Build: Build and test infrastructure changes
[ ] Core: Core fiftyone Python library changes
[x] Documentation: FiftyOne documentation changes
[ ] Other

Summary by CodeRabbit

New Features
- Added new sections: "Dataset Zoo" and "Model Zoo" in the documentation.
- Introduced a section on "FiftyOne Teams Built-in Orchestrator" for managing delegated operations.
- Enhanced documentation for plugin development with detailed guides and visual aids.
- Added a new TimelineView for custom animations in the app.
Bug Fixes
- Clarified references to the orchestration tool in various documentation sections.
- Fixed various issues related to overlay z-index and performance improvements in the app.
Documentation
- Expanded and refined existing sections for clarity and usability.
- Streamlined setup instructions for the built-in orchestrator in the Teams context.
- Updated release notes with enhancements and fixes across different components.

coderabbitai[bot] commented 1 week ago

Walkthrough

The pull request introduces several updates to the FiftyOne documentation, particularly focusing on the index.rst, developing_plugins.rst, index.rst for plugins, using_plugins.rst, and teams_plugins.rst files. Key changes include the clarification of the orchestration tool associated with FiftyOne Teams, the addition of new sections for "Dataset Zoo" and "Model Zoo," and enhancements to the guidance on developing and using plugins. The updates aim to improve clarity and usability without altering existing functionalities.

Changes

File Path	Change Summary
docs/source/index.rst	Updated orchestration tool reference; added new sections: `Dataset Zoo` and `Model Zoo`.
docs/source/plugins/developing_plugins.rst	Restructured content, detailed plugin components, expanded sections on plugin types (Python and JavaScript), added best practices, and included visual aids.
docs/source/plugins/index.rst	Updated orchestration tool reference; no additional changes.
docs/source/plugins/using_plugins.rst	Added a section on `FiftyOne Teams Builtin Orchestrator`, refined existing sections, expanded `Delegated operations` and removed content related to Apache Airflow.
docs/source/teams/teams_plugins.rst	Clarified use of plugins within Teams, detailed orchestrator setup, added new environment variables, and enhanced management of delegated operations.
docs/source/release-notes.rst	Updated release notes for versions 2.1.3 and 1.0.2, including model additions, bug fixes, and enhancements across various sections.

Possibly related PRs

#4433: This PR updates the release notes for FiftyOne Teams 1.7, which includes changes to the description of executing long-running tasks within the FiftyOne App, similar to the updates made in the main PR regarding the FiftyOne Plugins section.
#4456: This PR also modifies the release notes and includes updates related to the plugin descriptions, which aligns with the changes made in the main PR regarding the FiftyOne Plugins section.
#4838: This PR introduces a script that processes documentation, including the addition of new sections marked with __SUB_NEW__, which directly relates to the changes made in the main PR regarding the Dataset Zoo and Model Zoo.
#5021: This PR updates the release notes for FiftyOne Teams 2.1.2, which includes enhancements to delegated operations, reflecting the ongoing improvements in documentation and functionality noted in the main PR.

Suggested labels

documentation

Suggested reviewers

findtopher

🐇 In the garden where knowledge grows,
FiftyOne's plugins now brightly glow.
With new sections added, clarity reigns,
Developers cheer, no more pains!
From datasets to models, all in sight,
Hop along, let's code with delight! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

swheaton commented 1 week ago

Although if BM is good with it as exists now maybe I'll just throw my changes away and move on.

voxel51 / fiftyone