[HOLD] Update Docs for Fiftyone Enterprise #5096
Conversation
WalkthroughThe pull request encompasses a comprehensive rebranding of the FiftyOne documentation, replacing all instances of "FiftyOne Teams" with "FiftyOne Enterprise." This includes updates across various documentation files, such as README, installation guides, API connection, and plugin management. Additionally, several sections have been clarified or expanded, particularly regarding configuration settings, user roles, and plugin development. The overall structure and functionality of the documentation remain intact, with a focus on aligning the terminology with the new branding. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
| -------------------- | ||
| *Released October 31, 2024* | ||
|
|
||
| - Fixed an issue that prevented `delegation_target` from being properly set when | ||
| running delegated operations with orchestrator registration enabled | ||
|
|
||
| FiftyOne Teams 2.1.1 | ||
| FiftyOne Enterprise 2.1.1 |
There was a problem hiding this comment.
Let me know if there's a preference for the release notes that reference previous versions of the tool to remain "Fiftyone Teams" since that is what they were called at the time. I don't know if this would help with searching or to minimize confusion.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
🧹 Outside diff range and nitpick comments (19)
docs/generate_docs.bash (1)
18-18: Update variable name to match new terminologyWhile the help text has been updated to reference "Enterprise", the variable name
PATH_TO_TEAMSstill uses the old terminology. Consider updating it toPATH_TO_ENTERPRISEfor consistency.-PATH_TO_TEAMS="" +PATH_TO_ENTERPRISE=""Also applies to: 25-25
docs/source/enterprise/api_connection.rst (2)
33-35: Consider enhancing the API URI format documentation.While the rebranding changes look good, consider adding an example format for the API URI to help users understand what to expect (e.g.,
https://api.fiftyone.ai/v1or similar).
Line range hint
1-117: Documentation maintains clarity while implementing rebranding.The rebranding from Teams to Enterprise has been implemented consistently throughout the document while maintaining the technical accuracy of the content. The decision to keep environment variable names unchanged aligns with the PR objectives.
Consider creating a documentation test that validates all cross-references and image paths to catch any broken links early in the CI pipeline.
docs/source/enterprise/index.rst (2)
Missing Documentation Page: pluggable_auth.rst
The referenced documentation page
pluggable_auth.rstdoes not exist in thedocs/source/enterprisedirectory.
- Path:
docs/source/enterprise/pluggable_auth.rst🔗 Analysis chain
Line range hint
134-149: Verify all referenced documentation pages exist.The table of contents has been updated with Enterprise-specific pages.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that all referenced RST files exist # Test: Check if all documentation files exist in the enterprise directory cd docs/source/enterprise for page in "overview" "installation" "api_connection" "cloud_media" "roles_and_permissions" "dataset_versioning" "enterprise_app" "management_sdk" "enterprise_plugins" "secrets" "migrations" "pluggable_auth"; do if [ ! -f "${page}.rst" ]; then echo "Missing: ${page}.rst" fi doneLength of output: 3049
Broken Enterprise URLs Found
The updated Enterprise URLs in
docs/source/enterprise/index.rstare returning 404 errors.
https://voxel51.com/fiftyone-enterprisehttps://voxel51.com/schedule-enterprise-workshopPlease verify and update these URLs to point to the correct destinations.
🔗 Analysis chain
Line range hint
1-34: LGTM! Verify the updated URLs are accessible.The header and social links have been correctly updated to reflect the Enterprise branding.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that the new Enterprise URLs are accessible # Test: Check if the URLs return valid responses for url in "https://voxel51.com/fiftyone-enterprise" "https://voxel51.com/schedule-enterprise-workshop"; do curl -s -I "$url" | head -n 1 | grep "HTTP/" doneLength of output: 177
Script:
#!/bin/bash # Description: Verify that the new Enterprise URLs are accessible # Test: Check if the URLs return valid responses for url in "https://voxel51.com/fiftyone-enterprise" "https://voxel51.com/schedule-enterprise-workshop"; do curl -s -I "$url" | head -n 1 | grep "HTTP/" doneLength of output: 401
docs/source/enterprise/migrations.rst (3)
30-32: Add quotes around version specificationTo prevent potential shell interpretation issues, the version specification should be quoted.
Apply this improvement:
- pip install --index-url https://${TOKEN}@pypi.fiftyone.ai fiftyone==${VERSION} + pip install --index-url https://${TOKEN}@pypi.fiftyone.ai "fiftyone==${VERSION}"
44-50: Consider adding version compatibility informationWhile the workflow steps are clear, it would be helpful to add information about version compatibility requirements between the SDK and the Enterprise App infrastructure.
Consider adding a note like:
.. note:: Before upgrading, ensure that the SDK version you're upgrading to is compatible with your target Enterprise App infrastructure version. Incompatible versions may cause connectivity issues.
136-140: Add guidance for large dataset migrationsThe migration instructions should include considerations for handling large datasets.
Consider adding a note like:
.. note:: When migrating large datasets, consider: - Breaking the migration into smaller batches - Monitoring system resources during the export/import process - Planning for sufficient storage space in both source and destination - Estimating the time required for media uploads to cloud storagedocs/source/enterprise/pluggable_auth.md (5)
25-25: Fix spacing in "FiftyOneEnterprise"There should be a space between "FiftyOne" and "Enterprise".
-FiftyOneEnterprise +FiftyOne Enterprise
34-34: Fix grammatical structureThe sentence structure needs improvement.
-In internal mode, FiftyOne Enterprise the CAS replaces Auth0. +In internal mode, the CAS replaces Auth0 in FiftyOne Enterprise.
Line range hint
67-68: Update URL reference to use Enterprise instead of TeamsThe URL still contains a reference to "Teams" which should be updated to "Enterprise" for consistency.
-https://<YOUR_FIFTYONE_TEAMS_URL>/cas/configurations +https://<YOUR_FIFTYONE_ENTERPRISE_URL>/cas/configurations🧰 Tools
🪛 LanguageTool
[grammar] ~66-~66: The word “login” is a noun. The verb is spelled with a white space.
Context: ...ges/enterprise/cas/cas_sign_in.png) To login to this application navigate to `https:...(NOUN_VERB_CONFUSION)
124-126: Maintain consistent terminology in migration stepsThe steps should consistently use "Enterprise" terminology.
-1. Creating a FiftyOne Enterprise user profile via `POST /cas/api/users`. -1. Assigning the user to the default organization through a membership entry. -1. Linking the user's account to the new authentication provider by creating an +1. Create a FiftyOne Enterprise user profile via `POST /cas/api/users` +2. Assign the user to the default organization through a membership entry +3. Link the user's account to the new authentication provider by creating an
Line range hint
141-142: Update URL reference in Getting Started sectionThe URL still contains a reference to "Teams" which should be updated to "Enterprise" for consistency.
-https://<YOUR_FIFTYONE_TEAMS_URL>/cas/configurations +https://<YOUR_FIFTYONE_ENTERPRISE_URL>/cas/configurationsdocs/source/enterprise/cloud_media.rst (1)
35-35: Use a more descriptive example dataset nameConsider using a more meaningful example dataset name that reflects a real-world scenario, such as "cloud-backed-images" or "s3-backed-dataset".
- dataset = fo.load_dataset("a-enterprise-dataset") + dataset = fo.load_dataset("cloud-backed-images")Also applies to: 49-49
docs/source/enterprise/enterprise_plugins.rst (4)
15-20: Fix indentation in the note blockThe note block's content has inconsistent indentation which may affect rendering.
.. note:: - What can you do with plugins? Check out - :ref:`delegated operations <enterprise-delegated-operations>` to see some quick - examples, then check out the - `FiftyOne plugins <https://github.com/voxel51/fiftyone-plugins>`_ - repository for a growing collection of prebuilt plugins that you can add to - your Enterprise deployment! + What can you do with plugins? Check out + :ref:`delegated operations <enterprise-delegated-operations>` to see some quick + examples, then check out the + `FiftyOne plugins <https://github.com/voxel51/fiftyone-plugins>`_ + repository for a growing collection of prebuilt plugins that you can add to + your Enterprise deployment!
Line range hint
503-505: Update terminology for consistencyThe word "Team's" should be updated to "Enterprise" for consistency with the rebranding.
- The Orchestrator will need to have all of the required dependencies - installed for running your Team's operations. For example, if running the + The Orchestrator will need to have all of the required dependencies + installed for running your Enterprise operations. For example, if running the
Line range hint
481-491: Add security note for API key configurationThe
FIFTYONE_API_KEYenvironment variable configuration should include a security warning about protecting the admin API key.| FIFTYONE_API_KEY | api_key | The API key of an admin user that is used like a service account, | | | | to resolve secrets and check permissions | +| | | Note: Protect this key as it provides admin-level access. |
Line range hint
571-574: Add error handling guidance for Airflow setupConsider adding error handling guidance and troubleshooting steps for common issues during Airflow setup.
Add a note section like:
.. note:: If you encounter permission errors during Airflow setup, ensure that: - The user has sudo privileges - The necessary ports are open in your firewall - The service account has required permissionsdocs/source/release-notes.rst (1)
1519-1529: Consider adding more details about the debug loggingWhile the release note is clear, it would be helpful to provide more specifics about:
- What kind of debug events are being logged
- How to access/view these logs
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
⛔ Files ignored due to path filters (59)
docs/source/images/enterprise/admin_add_users_to_team.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/admin_create_group.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/admin_roles_page.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/admin_team_groups_page.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/admin_team_users_page.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/airflow.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/api_key_delete.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/api_key_generate.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/api_key_generated.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/cas/cas_api_docs.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/cas/cas_sign_in.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/cloud_creds_add_btn.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/cloud_creds_modal_blank.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/create_dataset.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/create_secret_form.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/dataset_access.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/dataset_basic_info.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/dataset_danger_zone.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/dataset_default_access.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/dataset_search_bar.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/dataset_search_fields.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/dataset_specific_access.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/enterprise_architecture.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/hero.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/homepage.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/install_fiftyone.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/ordering_datasets.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/pinned_datasets.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_disable.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_install.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_install_btn.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_install_success.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_operators_btn.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_operators_disable.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_operators_perms.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_operators_perms2.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_org_settings.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_page.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_uninstall_btn.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_upgrade_btn.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_upgrade_page.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/plugins_upgrade_success_page.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/samples_page.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/secrets_page.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/share_dataset.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/user_invitation.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/versioning/archive-snapshot.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/versioning/browse-banner-dropdown.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/versioning/browse-banner-right.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/versioning/browse-banner-right2.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/versioning/browse-button.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/versioning/create-refresh-button.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/versioning/create-save-button.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/versioning/delete-snapshot.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/versioning/history-new-snapshot.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/versioning/history-tab-button.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/versioning/rollback-snapshot.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/versioning/snapshot-list.pngis excluded by!**/*.png,!**/*.pngdocs/source/images/enterprise/versioning/unarchive-snapshot.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (28)
docs/README.md(1 hunks)docs/generate_docs.bash(4 hunks)docs/source/_templates/layout.html(2 hunks)docs/source/cheat_sheets/fiftyone_terminology.rst(1 hunks)docs/source/conf.py(3 hunks)docs/source/deprecation.rst(1 hunks)docs/source/enterprise/api_connection.rst(6 hunks)docs/source/enterprise/cloud_media.rst(14 hunks)docs/source/enterprise/dataset_versioning.rst(22 hunks)docs/source/enterprise/enterprise_app.rst(8 hunks)docs/source/enterprise/enterprise_plugins.rst(25 hunks)docs/source/enterprise/index.rst(7 hunks)docs/source/enterprise/installation.rst(19 hunks)docs/source/enterprise/management_sdk.rst(8 hunks)docs/source/enterprise/migrations.rst(8 hunks)docs/source/enterprise/overview.rst(3 hunks)docs/source/enterprise/pluggable_auth.md(8 hunks)docs/source/enterprise/roles_and_permissions.rst(15 hunks)docs/source/enterprise/secrets.rst(3 hunks)docs/source/environments/index.rst(1 hunks)docs/source/faq/index.rst(1 hunks)docs/source/getting_started/install.rst(1 hunks)docs/source/index.rst(2 hunks)docs/source/plugins/developing_plugins.rst(1 hunks)docs/source/plugins/using_plugins.rst(3 hunks)docs/source/recipes/creating_views.ipynb(1 hunks)docs/source/release-notes.rst(53 hunks)docs/source/user_guide/config.rst(1 hunks)
✅ Files skipped from review due to trivial changes (8)
- docs/source/enterprise/dataset_versioning.rst
- docs/source/enterprise/enterprise_app.rst
- docs/source/enterprise/installation.rst
- docs/source/enterprise/management_sdk.rst
- docs/source/enterprise/overview.rst
- docs/source/faq/index.rst
- docs/source/plugins/using_plugins.rst
- docs/source/recipes/creating_views.ipynb
🔇 Additional comments (38)
docs/source/deprecation.rst (1)
35-35: LGTM! Rebranding change looks correct.
The terminology change from "Teams" to "Enterprise" aligns with the PR objectives.
Let's verify if there are any remaining "Teams" references in the documentation:
✅ Verification successful
All "Teams" references successfully removed.
No remaining instances of "FiftyOne Teams" found in the documentation.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Search for remaining "Teams" references in documentation
# Expected: No instances of "FiftyOne Teams" should remain in the docs
echo "Searching for 'FiftyOne Teams' in documentation..."
rg -i "fiftyone\s+teams" docs/
echo "Searching for potentially missed file/directory names containing 'teams'..."
fd -i teams docs/
Length of output: 336
docs/source/enterprise/secrets.rst (3)
12-19: LGTM! Clear and consistent description
The main description effectively explains the purpose and benefits of the Secrets interface while maintaining consistent Enterprise branding.
Line range hint 51-95: LGTM! Comprehensive coverage of secret usage
This section effectively covers:
- Plugin configuration requirements
- Runtime secret access
- Environment compatibility
- Multiple deployment scenarios
The examples and explanations are clear and technically accurate.
28-29: Verify the updated image paths
The image paths have been updated to use the enterprise directory. Let's verify these images exist and are accessible.
Also applies to: 35-36
✅ Verification successful
Image paths verified successfully
All referenced images exist in the docs/source/images/enterprise directory.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that the referenced images exist in the correct location
fd "secrets_page.png|create_secret_form.png" "docs/source/images/enterprise"
Length of output: 176
docs/generate_docs.bash (3)
Line range hint 77-91: LGTM! Clear and accurate feedback messages
The symlink creation logic and feedback messages have been appropriately updated to reflect the Enterprise branding.
Line range hint 130-134: LGTM! Clean symlink removal
The symlink removal logic and comment have been appropriately updated to reflect the Enterprise branding.
Line range hint 1-139: Verify documentation build process
While the terminology updates look good, it would be valuable to verify that the documentation builds correctly with these changes.
docs/README.md (1)
69-75: LGTM! The Enterprise SDK section updates look consistent.
The changes align with the rebranding effort from Teams to Enterprise, maintaining the documentation's structure while updating the terminology.
Let's verify that there are no lingering references to the old path:
docs/source/enterprise/api_connection.rst (3)
72-72: Verify image path updates.
The image paths have been updated from /images/teams/ to /images/enterprise/. Let's ensure these images exist in the new location.
#!/bin/bash
# Description: Verify that the referenced images exist
# Check for the existence of the new image files
fd "api_key_generate.png|api_key_generated.png" docs/source/images/enterprise/Also applies to: 79-79
108-108: Verify deletion image path.
The image path has been updated to use the enterprise directory. Let's verify this image exists.
#!/bin/bash
# Description: Verify that the API key deletion image exists
fd "api_key_delete.png" docs/source/images/enterprise/Line range hint 1-21: LGTM! Verify cross-references.
The rebranding changes in the introduction section are consistent. References have been properly updated from Teams to Enterprise.
Let's verify all cross-references are valid:
✅ Verification successful
Verified: All cross-references have been successfully updated and are valid.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that the referenced sections exist in the documentation
# Check for enterprise-python-sdk reference
rg -l "enterprise-python-sdk" docs/
# Check for configuring-mongodb-connection reference
rg -l "configuring-mongodb-connection" docs/
Length of output: 197
Script:
#!/bin/bash
# Description: Verify that the referenced sections exist in the documentation
# Check for enterprise-python-sdk reference
rg -l 'enterprise-python-sdk' docs/
# Check for configuring-mongodb-connection reference
rg -l 'configuring-mongodb-connection' docs/
Length of output: 651
docs/source/enterprise/index.rst (3)
35-42: LGTM! Clear and accurate product description.
The description effectively communicates the Enterprise offering while maintaining the important backwards compatibility statement.
Line range hint 60-116: LGTM! Consistent Enterprise branding across all callouts.
The callout items have been thoroughly updated to reflect Enterprise branding while maintaining consistent formatting and structure.
46-48: Verify the new enterprise hero image exists.
The image path has been updated to reflect the Enterprise branding.
#!/bin/bash
# Description: Verify that the enterprise hero image exists
# Test: Check if the image file exists in the new path
fd "hero.png" docs/source/images/enterprise/docs/source/cheat_sheets/fiftyone_terminology.rst (2)
23-24: LGTM! Rebranding changes look accurate.
The terminology update from "Teams" to "Enterprise" is clear and consistent with the PR objectives. The description maintains the same professional tone while accurately representing the enterprise-grade capabilities.
24-24: Verify the Enterprise URL accessibility.
Let's ensure the new URL is accessible and consistent across documentation.
✅ Verification successful
The Enterprise URL is accessible and consistently used across all documentation.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the Enterprise URL accessibility and consistency
# Check if the old Teams URL still exists in any documentation files
echo "Checking for any remaining references to the old Teams URL..."
rg -l "voxel51.com/fiftyone-teams"
# Check for consistency of the new Enterprise URL
echo "Checking for consistency of the new Enterprise URL..."
rg -l "voxel51.com/fiftyone-enterprise"
Length of output: 463
docs/source/enterprise/migrations.rst (1)
1-14: LGTM: References and introduction are properly updated
The terminology changes from "Teams" to "Enterprise" have been consistently applied throughout the introduction and cross-references.
docs/source/getting_started/install.rst (2)
15-15: LGTM: Terminology update is consistent with rebranding.
The reference change from "Teams" to "Enterprise" is correctly implemented and maintains proper RST syntax.
15-15: Verify complete rebranding coverage.
Let's ensure we haven't missed any "Teams" references that should be updated to "Enterprise".
✅ Verification successful
Rebranding coverage verified successfully. All "Teams" references are updated to "Enterprise", excluding environment variables as per PR objectives.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Search for remaining "Teams" references in documentation
# Note: Excluding environment variables as mentioned in PR objectives
# Search for "Teams" in RST files
echo "Searching for 'Teams' references in documentation..."
rg -i "teams" "docs/source/" \
--type rst \
--glob "!{env,environment}*" \
-C 2
# Search for "teams" in filenames
echo -e "\nSearching for 'teams' in filenames..."
fd "teams" "docs/source/" --type f
Length of output: 1532
docs/source/conf.py (1)
16-16: Verify import order change impact
Moving the fiftyone.constants import before custom imports but after sys.path.insert could affect module resolution.
#!/bin/bash
# Description: Check if fiftyone.constants is imported correctly in other files
# and verify no circular imports are introduced
# Search for other files importing fiftyone.constants
rg -l "import.*fiftyone.constants" --type python
# Check for potential circular imports
rg -l "from custom_directives import|import custom_directives" --type pythondocs/source/_templates/layout.html (2)
45-45: Verify template variable definition
The branding update from "Teams" to "Enterprise" looks good. However, ensure that the template variable link_fiftyone_enterprise is properly defined in the configuration.
✅ Verification successful
Template variable link_fiftyone_enterprise is properly defined
The template variable link_fiftyone_enterprise is correctly defined in the configuration files.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for the template variable definition
rg -l "link_fiftyone_enterprise" docs/source/conf.py docs/source/_templates/
Length of output: 131
135-135: Check for any remaining "Teams" references
The footer branding update looks good and is consistent with the navigation menu change.
docs/source/enterprise/roles_and_permissions.rst (5)
1-18: LGTM! Document structure and introduction are well-organized.
The reference anchor and introduction have been properly updated to reflect the Enterprise branding while maintaining clarity about the collaboration features.
Line range hint 135-295: LGTM! Permissions section is comprehensive and accurate.
The permissions documentation is well-structured and all references have been properly updated to use the "enterprise-" prefix. The explanation of permission levels and inheritance is clear and accurate.
Line range hint 105-112: Verify UI path consistency
The text mentions "Settings > Team > Groups". As part of the Enterprise rebranding, should this be updated to "Settings > Enterprise > Groups"?
#!/bin/bash
# Search for other occurrences of similar UI paths
rg -i "settings.*team.*groups" --type rst300-301: Verify UI path consistency
The text mentions "Settings > Security > Roles". Please verify if this UI path is correct and consistent with the Enterprise rebranding.
#!/bin/bash
# Search for other occurrences of similar UI paths
rg -i "settings.*security.*roles" --type rst31-31: Verify image paths after directory renaming
Since the PR involves renaming directories, please verify that all image paths under /images/enterprise/ are correct and the images are present in the new location.
#!/bin/bash
# Check if the referenced images exist in the enterprise directory
for img in admin_team_users_page.png admin_team_groups_page.png admin_create_group.png admin_add_users_to_team.png dataset_default_access.png share_dataset.png dataset_specific_access.png admin_roles_page.png; do
if [ ! -f "docs/source/images/enterprise/$img" ]; then
echo "Missing image: $img"
fi
doneAlso applies to: 115-115, 122-122, 126-126, 178-178, 199-199, 203-203, 305-305
docs/source/index.rst (1)
480-480: LGTM: Section title updated consistently with rebranding
The table of contents entry has been updated to reflect the rebranding while maintaining the existing structure and styling.
#!/bin/bash
# Description: Verify consistency of enterprise-related terms in the documentation
# Expected: No remaining references to "teams" in the enterprise documentation
# Search for any remaining "teams" references in RST files
rg -i "teams" --type rstdocs/source/enterprise/pluggable_auth.md (2)
78-80: LGTM!
The Identity Providers section correctly uses the Enterprise terminology and provides clear configuration instructions.
171-175: LGTM!
The JavaScript hooks and configuration sections are well-documented and correctly use the Enterprise terminology.
docs/source/enterprise/cloud_media.rst (1)
13-14: Verify the cross-reference target exists
Please ensure that the target enterprise-cloud-credentials exists in the documentation.
✅ Verification successful
Cross-reference target exists
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the cross-reference target exists
rg -l "^\.\. _enterprise-cloud-credentials:$" docs/source/
Length of output: 100
docs/source/enterprise/enterprise_plugins.rst (1)
686-688: LGTM: Image reference updated correctly
The image reference has been properly updated to use the new enterprise path.
docs/source/user_guide/config.rst (1)
66-66: LGTM! Terminology update is consistent.
The change from "Teams SDK" to "Enterprise SDK" aligns with the rebranding effort.
Let's verify no other instances of "Teams" remain in this file:
docs/source/plugins/developing_plugins.rst (1)
1326-1328: LGTM! Terminology update matches PR objectives.
The reference to "FiftyOne Enterprise" is correctly updated from "Teams" to align with the rebranding effort.
docs/source/release-notes.rst (4)
Line range hint 6-24: LGTM! Clear and well-structured release notes for Enterprise 2.1.3
The release notes effectively communicate:
- Version and release date
- Inclusion of Community updates
- Specific Enterprise changes
Line range hint 55-110: LGTM! Well-organized release notes for Enterprise 2.1.2
The release notes provide:
- Clear version and release date
- Comprehensive list of changes
- Good organization by component (General, Admin, SDK)
903-915: LGTM! Concise release notes for Enterprise 1.5.7
The notes effectively communicate:
- Version and release date
- Inclusion of Community updates
- Specific Enterprise improvements and bug fixes
Line range hint 2774-2807: LGTM! Clear historical release notes
The older release notes maintain consistent structure and detail level with newer releases.
docs/source/enterprise/secrets.rst
Outdated
| such as API tokens and login credentials in a secure manner for use by your | ||
| :ref:`Team's plugins <teams-plugins>`. | ||
| :ref:`Team's plugins <enterprise-plugins>`. |
There was a problem hiding this comment.
Update remaining "Team's" reference to align with Enterprise branding
The text still contains "Team's plugins" which should be updated to "Enterprise plugins" for consistency with the rebranding effort.
-:ref:`Team's plugins <enterprise-plugins>`.
+:ref:`Enterprise plugins <enterprise-plugins>`.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| :ref:`Team's plugins <enterprise-plugins>`. | |
| :ref:`Enterprise plugins <enterprise-plugins>`. |
docs/source/index.rst
Outdated
| :image_link: enterprise/installation.html#google-cloud-storage | ||
| :image_src: https://voxel51.com/images/integrations/google-cloud-128.png | ||
| :image_title: Google Cloud | ||
|
|
||
| .. customimagelink:: | ||
| :image_link: teams/installation.html#amazon-s3 | ||
| :image_link: enterprise/installation.html#amazon-s3 | ||
| :image_src: https://voxel51.com/images/integrations/aws-128.png | ||
| :image_title: Amazon Web Services | ||
|
|
||
| .. customimagelink:: | ||
| :image_link: teams/installation.html#microsoft-azure | ||
| :image_link: enterprise/installation.html#microsoft-azure |
There was a problem hiding this comment.
💡 Codebase verification
Remaining references to "teams" found in enterprise documentation
The following files still contain references to "teams" and should be updated to "enterprise":
docs/source/enterprise/installation.rstdocs/source/enterprise/cloud_media.rst
🔗 Analysis chain
Verify that the new enterprise documentation paths are accessible
The cloud storage integration links have been updated to point to the enterprise documentation. Let's verify that these new paths exist and are accessible.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the new enterprise documentation paths exist
# Expected: Files should exist at these locations
# Search for the enterprise installation documentation files
fd --type f "installation.*" enterprise/
Length of output: 474
docs/source/environments/index.rst
Outdated
| @@ -519,7 +519,7 @@ environments. | |||
| not recommended or officially supported. It is useful only for prototyping. | |||
|
|
|||
| Our recommended, scalable approach to work with cloud-backed data is | |||
| :ref:`FiftyOne Teams <fiftyone-teams>`, an enterprise deployment of | |||
| :ref:`FiftyOne Enterprise <fiftyone-enterprise>`, an enterprise deployment of | |||
There was a problem hiding this comment.
💡 Codebase verification
Update remaining "Teams" references in the documentation to "Enterprise".
- Found remaining occurrences in:
docs/source/enterprise/installation.rstdocs/source/enterprise/cloud_media.rst
🔗 Analysis chain
LGTM! Verify the cross-reference target exists.
The terminology change from "Teams" to "Enterprise" aligns with the PR objectives.
Let's verify that the referenced section exists with the new name to avoid broken links:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the Enterprise documentation section exists
# Expected: Find the target of the cross-reference to avoid broken links
# Search for the Enterprise section definition
rg "^\.\. _fiftyone-enterprise:" docs/
# Search for any remaining references to "Teams"
rg -i "teams" docs/ --type rst
Length of output: 579
| We recommend including Enterprise in your function’s `requirements.txt` file by | ||
| passing your token as a build environment variable, e.g., | ||
| `FIFTYONE_TEAMS_TOKEN` and then using the syntax below to specify the version | ||
| of the Teams client to use: | ||
| of the Enterprise client to use: |
There was a problem hiding this comment.
Update environment variable name to match Enterprise branding
The environment variable FIFTYONE_TEAMS_TOKEN should be updated to FIFTYONE_ENTERPRISE_TOKEN to maintain consistency with the rebranding effort.
-`FIFTYONE_TEAMS_TOKEN` and then using the syntax below to specify the version
+`FIFTYONE_ENTERPRISE_TOKEN` and then using the syntax below to specify the version📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| We recommend including Enterprise in your function’s `requirements.txt` file by | |
| passing your token as a build environment variable, e.g., | |
| `FIFTYONE_TEAMS_TOKEN` and then using the syntax below to specify the version | |
| of the Teams client to use: | |
| of the Enterprise client to use: | |
| We recommend including Enterprise in your function's `requirements.txt` file by | |
| passing your token as a build environment variable, e.g., | |
| `FIFTYONE_ENTERPRISE_TOKEN` and then using the syntax below to specify the version | |
| of the Enterprise client to use: |
^^ this one |
| "colab": { | ||
| "base_uri": "https://localhost:8080/" | ||
| "collapsed_sections": [], | ||
| "name": "FiftyOne_Enterprise_View_Expressions.ipynb", |
There was a problem hiding this comment.
I don't know what happened here. This file got heavily edited unintentionally based on the diff, I just restored it back to the base release branch
There was a problem hiding this comment.
the .ipynb files might need to be manually inspected and edited tbh
docs/source/enterprise/overview.rst
Outdated
|
|
||
| FiftyOne Teams Overview | ||
| FiftyOne Enterprise Overview | ||
| ======================= |
There was a problem hiding this comment.
The line lengths for 3 and 4 need to match, I believe (a general note)
There was a problem hiding this comment.
Good catch, thanks!
There was a problem hiding this comment.
technically len(4) just has to be >= len(3)
but brian has liked it to be exactly equal idk.
but ya great catch. would be pretty apparent on doc build
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (13)
docs/source/teams/api_connection.rst (1)
Update remaining "teams" references to "Enterprise" for consistency
The following files still reference "teams-api-connection":
- docs/source/teams/installation.rst
- docs/source/teams/management_sdk.rst
- docs/source/teams/api_connection.rst
- docs/source/release-notes.rst
- docs/source/user_guide/config.rst
Ensure all references are updated to maintain consistency and prevent broken links.
🔗 Analysis chain
Line range hint
1-1: Consider updating file path and anchor names for consistencyWhile the content has been updated to use "Enterprise", the following still reference "teams":
- File path:
docs/source/teams/api_connection.rst- Anchor:
teams-api-connectionThis might cause confusion or break documentation links if not handled carefully.
Consider creating a comprehensive migration plan to:
- Update file paths
- Update anchor references
- Ensure proper redirects or compatibility layer for existing links
Also applies to: 9-9, 19-19
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check for any remaining references to these anchors in other documentation files rg -l "teams-api-connection" --type rstLength of output: 286
Script:
#!/bin/bash # Check for any remaining references to "teams-api-connection" anchors in other documentation files rg -l "teams-api-connection" --type rstLength of output: 212
docs/source/teams/index.rst (2)
Line range hint
11-12: Update social links URLs to reflect Enterprise brandingThe social links section contains outdated URLs that still reference "teams":
voxel51.com/fiftyone-teamsshould be updated tovoxel51.com/fiftyone-enterprisevoxel51.com/schedule-teams-workshopshould be updated tovoxel51.com/schedule-enterprise-workshopAlso applies to: 17-18
Line range hint
144-149: Update toctree entries to use Enterprise terminologyThe following toctree entries need to be updated:
teams_app→enterprise_appteams_plugins→enterprise_pluginsEnsure that the corresponding files are renamed accordingly.
docs/source/teams/migrations.rst (2)
8-11: Update internal reference names for consistencyThe internal references still use the 'teams-' prefix (e.g.,
teams-upgrading,teams-upgrade-python-sdk). Consider updating these to use 'enterprise-' prefix for consistency with the rebranding effort.
Line range hint
136-175: Consider adding a note about data persistenceThe migration instructions are clear and accurate. However, it might be helpful to add a note about data persistence and any potential downtime during the migration process.
Consider adding a note like:
.. note:: During the migration process, ensure that no other processes are actively modifying the dataset to maintain data consistency. The migration process is non-destructive and your original dataset remains unchanged.docs/source/index.rst (1)
Line range hint
480-493: Remove placeholder markers from new sectionsThe
__SUB_NEW__markers in the table of contents appear to be placeholders and should be removed.Apply this diff to clean up the table of contents:
- Dataset Zoo __SUB_NEW__ <dataset_zoo/index> - Model Zoo __SUB_NEW__ <model_zoo/index> + Dataset Zoo <dataset_zoo/index> + Model Zoo <model_zoo/index>docs/source/teams/installation.rst (4)
Line range hint
27-76: Update remaining "teams" references in Python SDK sectionThe following items need to be updated:
- Reference anchor:
:ref:teams-app``- Image path:
/images/teams/install_fiftyone.png
Line range hint
78-162: Update Poetry configuration to use Enterprise terminologySeveral Poetry-related configurations still use "teams":
- Source name:
fiftyone-teams- Environment variables:
POETRY_HTTP_BASIC_FIFTYONE_TEAMS_USERNAME- Poetry add command:
--source fiftyone-teamsConsider updating these to maintain consistency with the Enterprise branding.
Line range hint
163-632: Consider updating example URLs and anchors in cloud storage sectionWhile the PR objectives mention keeping environment variables unchanged, consider updating:
- Example URLs:
https://fiftyone-teams-deployment.yourcompany.com- Reference anchors:
teams-cloud-credentials,teams-cors, etc.Note: As mentioned in the PR objectives, environment variables can remain unchanged for now pending further testing.
Multiple "teams" references found across documentation files
The rebranding from "Teams" to "Enterprise" is incomplete. The following files still reference "teams" and need to be updated:
docs/source/release-notes.rstdocs/source/teams/migrations.rstdocs/source/teams/teams_plugins.rstdocs/source/user_guide/config.rstdocs/source/teams/index.rstdocs/source/teams/api_connection.rstdocs/source/teams/dataset_versioning.rstdocs/source/teams/management_sdk.rstdocs/source/teams/cloud_media.rstdocs/source/plugins/developing_plugins.rstdocs/source/teams/secrets.rstdocs/source/teams/teams_app.rstdocs/source/teams/roles_and_permissions.rstdocs/source/teams/overview.rstPlease ensure all instances of "teams" are updated to "Enterprise" for consistency.
🔗 Analysis chain
Line range hint
1-24: Update file path and reference anchor for consistencyWhile the content has been updated to use "Enterprise", the following items still reference "teams":
- File path:
docs/source/teams/installation.rst- Reference anchor:
.. _teams-installation:Consider updating these for complete consistency with the rebranding effort.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check for other RST files that might reference this anchor rg "teams-installation" --type rstLength of output: 21250
docs/source/release-notes.rst (3)
Line range hint
6-10: Inconsistent release note formatting and version numberingThe release notes show inconsistencies in formatting and version numbering:
- Some version headers use dashes (e.g., "FiftyOne Enterprise 1.5.2") while others use dots (e.g., "FiftyOne Enterprise 1.5.10")
- The number of dashes used for RST section underlines varies between versions
- Some versions include explicit "News" or "General" sections while others directly list changes
- Some versions have "Bugs" sections while others mix bug fixes with features
Consider standardizing the format across all release notes for better readability.
-FiftyOne Enterprise 2.1.3 -------------------- +FiftyOne Enterprise 2.1.3 ------------------------- News ---- General ------- Bugs ----Also applies to: 55-61, 62-110, 217-324, 469-530, 531-531, 632-638, 641-656, 659-665, 796-803, 1008-1014, 1035-1047, 1154-1164, 1250-1261, 1261-1296, 1296-1340, 1782-1788, 1792-1929, 2112-2166, 2187-2207, 2296-2314, 2319-2322, 2776-2785, 2809-2840, 2850-2850, 3048-3057
531-531: Inconsistent indentation in text changesThe text changes at lines 531, 2319-2322, and 2850 have inconsistent indentation compared to surrounding content. This could affect RST rendering.
Also applies to: 2319-2322, 2850-2850
Line range hint
1261-1296: Duplicate version headerThe version 1.5.1 header appears twice in the file (lines 1261 and 1296). This appears to be a copy-paste error.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (25)
docs/README.md(1 hunks)docs/generate_docs.bash(1 hunks)docs/source/_templates/layout.html(2 hunks)docs/source/cheat_sheets/fiftyone_terminology.rst(1 hunks)docs/source/environments/index.rst(1 hunks)docs/source/faq/index.rst(1 hunks)docs/source/getting_started/install.rst(1 hunks)docs/source/index.rst(1 hunks)docs/source/plugins/developing_plugins.rst(1 hunks)docs/source/plugins/using_plugins.rst(3 hunks)docs/source/release-notes.rst(50 hunks)docs/source/teams/api_connection.rst(4 hunks)docs/source/teams/cloud_media.rst(5 hunks)docs/source/teams/dataset_versioning.rst(16 hunks)docs/source/teams/index.rst(6 hunks)docs/source/teams/installation.rst(13 hunks)docs/source/teams/management_sdk.rst(1 hunks)docs/source/teams/migrations.rst(7 hunks)docs/source/teams/overview.rst(3 hunks)docs/source/teams/pluggable_auth.md(7 hunks)docs/source/teams/roles_and_permissions.rst(4 hunks)docs/source/teams/secrets.rst(2 hunks)docs/source/teams/teams_app.rst(6 hunks)docs/source/teams/teams_plugins.rst(16 hunks)docs/source/user_guide/config.rst(1 hunks)
✅ Files skipped from review due to trivial changes (8)
- docs/source/teams/cloud_media.rst
- docs/source/teams/dataset_versioning.rst
- docs/source/teams/management_sdk.rst
- docs/source/teams/overview.rst
- docs/source/teams/roles_and_permissions.rst
- docs/source/teams/secrets.rst
- docs/source/teams/teams_app.rst
- docs/source/teams/teams_plugins.rst
🚧 Files skipped from review as they are similar to previous changes (9)
- docs/README.md
- docs/generate_docs.bash
- docs/source/_templates/layout.html
- docs/source/cheat_sheets/fiftyone_terminology.rst
- docs/source/environments/index.rst
- docs/source/faq/index.rst
- docs/source/getting_started/install.rst
- docs/source/plugins/using_plugins.rst
- docs/source/user_guide/config.rst
🧰 Additional context used
🪛 LanguageTool
docs/source/teams/pluggable_auth.md
[uncategorized] ~34-~34: Possible missing comma found.
Context: ...ternal Mode In internal mode, FiftyOne Enterprise the CAS replaces Auth0. FiftyOne Enterp...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (12)
docs/source/teams/api_connection.rst (2)
33-33: LGTM! Environment variables maintained as planned
The configuration table updates correctly reflect the Enterprise terminology while maintaining the existing environment variables, which aligns with the PR objectives.
Also applies to: 35-35
65-65: Verify and update screenshot paths
The text refers to the "FiftyOne Enterprise App", but the image paths still use the "teams" prefix:
/images/teams/api_key_generate.png
/images/teams/api_key_generated.png
#!/bin/bash
# Check for image files and their locations
fd "api_key_.*\.png" docs/source/images/Consider:
- Updating image paths to match the new terminology
- Verifying that the screenshots reflect the current Enterprise UI
Also applies to: 73-73, 79-79
docs/source/teams/index.rst (3)
35-42: LGTM! Description properly reflects Enterprise branding
The main description section has been correctly updated to use the new Enterprise terminology while maintaining clear and accurate content.
92-92:
Update file paths in button links to use Enterprise terminology
Some button links still reference the old "teams" terminology:
teams_app.htmlshould be updated toenterprise_app.htmlteams_plugins.htmlshould be updated toenterprise_plugins.html
Ensure that these files are also renamed as part of the rebranding effort.
Let's verify if these files exist and check for any references:
#!/bin/bash
# Check for the existence of both old and new filenames
fd -e html "teams_app|teams_plugins|enterprise_app|enterprise_plugins" docs/source
# Search for references to these files
rg -t rst "teams_app\.html|teams_plugins\.html" docs/sourceAlso applies to: 104-104
Line range hint 1-149: Consider relocating file to enterprise directory
This file is currently located in the docs/source/teams directory. For complete consistency with the rebranding effort, consider:
- Creating a new
docs/source/enterprisedirectory - Moving this file and related documentation to the new directory
- Updating all references to the documentation path
Let's check for other files that might need to be moved and references that need updating:
#!/bin/bash
# List all files in the teams directory
fd . docs/source/teams
# Search for references to the teams directory
rg -t rst -t py "teams/[^/]+" docs/sourcedocs/source/teams/migrations.rst (2)
Line range hint 106-133: LGTM: Downgrade instructions are clear and accurate
The downgrade section provides clear instructions with appropriate version references and necessary warnings.
36-38: Update anchor reference in note section
The note references :ref:account icon ``, but this anchor might need to be updated to maintain consistency with the Enterprise rebranding.
✅ Verification successful
Anchor reference teams-python-sdk is up-to-date and exists in the codebase.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the referenced anchor exists and if it needs updating
rg ".. _teams-python-sdk:" docs/source/
Length of output: 98
docs/source/index.rst (2)
Line range hint 1-493: Verify all "teams" references have been updated
Let's verify that all references to "teams" have been updated to "enterprise" throughout the documentation.
480-480:
Update cloud storage integration links to use "enterprise" paths
The cloud storage integration links in the documentation still point to the old "teams" paths. These should be updated to maintain consistency with the rebranding.
Apply this diff to update the paths:
- :image_link: teams/installation.html#google-cloud-storage
+ :image_link: enterprise/installation.html#google-cloud-storage
- :image_link: teams/installation.html#amazon-s3
+ :image_link: enterprise/installation.html#amazon-s3
- :image_link: teams/installation.html#microsoft-azure
+ :image_link: enterprise/installation.html#microsoft-azureLikely invalid or redundant comment.
docs/source/teams/installation.rst (1)
Line range hint 1-632: Verify cross-references in other documentation files
The changes to reference anchors and file paths may affect other documentation files that link to this content.
#!/bin/bash
# Check for files that might be affected by anchor changes
echo "Checking for references to teams-installation anchor..."
rg "teams-installation" --type rst
echo "Checking for references to teams-cloud-credentials anchor..."
rg "teams-cloud-credentials" --type rst
echo "Checking for references to teams-cors anchor..."
rg "teams-cors" --type rst
# Check for other potential cross-references
echo "Checking for other potential cross-references..."
rg "teams-[a-zA-Z-]+" --type rstdocs/source/plugins/developing_plugins.rst (2)
Line range hint 1-1325: LGTM!
The rest of the documentation looks good and doesn't contain any references to "Teams" that need to be updated.
Also applies to: 1329-2024
1326-1328:
Update "Teams" reference to "Enterprise"
This section still contains a reference to "FiftyOne Teams" that should be updated to "FiftyOne Enterprise" as part of the rebranding effort.
Apply this diff to update the terminology:
- :ref:`FiftyOne Teams <fiftyone-teams>` users can view the current progress
+ :ref:`FiftyOne Enterprise <fiftyone-teams>` users can view the current progressLikely invalid or redundant comment.
| .. _fiftyone-teams: | ||
|
|
||
| FiftyOne Teams | ||
| ============== | ||
| FiftyOne Enterprise | ||
| =================== |
There was a problem hiding this comment.
💡 Codebase verification
Update all references from fiftyone-teams to fiftyone-enterprise
Multiple references to fiftyone-teams were found in the following files. Please update them to fiftyone-enterprise to ensure consistency with the new branding:
docs/source/release-notes.rstdocs/source/index.rstdocs/source/conf.pydocs/source/cheat_sheets/fiftyone_terminology.rstdocs/source/teams/index.rst- (additional files as necessary)
🔗 Analysis chain
Update the anchor tag to match Enterprise branding
The anchor tag _fiftyone-teams should be updated to _fiftyone-enterprise for consistency with the new branding.
Let's verify existing references to this anchor before making the change:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for references to the teams anchor tag in RST files
rg -t rst ":ref:\`.*fiftyone-teams.*\`"
Length of output: 6635
brimoor
changed the title
What changes are proposed in this pull request?
Modifying the docs to change the verbage of
Teams->EnterpriseBroken into 2 commits: one is lower-touch and only replaces the user facing elements with literal
Teams-- shouldn't impact any docs building or functionalityThe second commit also removes any other references to
teamsand renames dirs and filenames that previously references teams -- should remove all references EXCEPT some environment variables, which I don't think we should switch over right now without additional testing.Happy to merge both if this change doesn't impact doc building or other references, but if the second is too much this close to release, we can only keep the first commit so that at least the visible docs will be correct.
Summary by CodeRabbit
Release Notes
New Features
Documentation Updates
Bug Fixes
These changes enhance user experience and align the platform with its enterprise offerings.