fix teams install command

[findtopher]

What changes are proposed in this pull request?

Well... that's been broken for a while and definitely doesn't work...

Summary by CodeRabbit

• Documentation
  • Updated installation instructions for the FiftyOne Teams Python SDK to clarify the process and configuration.
  • Changed environment variable syntax for consistency.
  • Expanded guidance on using Poetry, including private source setup and credential configuration.
  • Added detailed instructions for configuring cloud credentials for AWS, Google Cloud Storage, Microsoft Azure, and MinIO.
  • Introduced a new section on managing cloud credentials through the Teams UI, including bucket-specific credentials management.

[coderabbitai]

Walkthrough

The pull request updates the documentation for the FiftyOne Teams installation process, specifically for the Python SDK. It modifies the installation command syntax for environment variables, clarifies the module structure, and expands instructions for using Poetry. Additionally, it details cloud credential configuration for various providers and introduces a section on managing these credentials through the Teams UI. Overall, the changes aim to enhance clarity and usability for users setting up and configuring the FiftyOne Teams environment.

Changes

File	Change Summary
docs/source/teams/installation.rst	Updated installation command syntax and added detailed instructions for configuring cloud credentials. Expanded Poetry installation guidance and clarified module structure. Introduced management of cloud credentials through the Teams UI.

Possibly related PRs

• Release notes v1.0.1 #4898: Updates to the release notes for FiftyOne Teams, relating to installation documentation clarifications.
• Merge release/v1.0.1 to develop #4911: Similar updates to release notes, relevant to installation and configuration processes.
• updated release notes #5021: Introduction of a new release note section for FiftyOne Teams, connecting to installation and configuration improvements.
• Merge v2.1.2 to develop #5023: Merging of release notes for FiftyOne Teams, emphasizing clear documentation for users.

Suggested labels

documentation

Suggested reviewers

• swheaton

Poem

In the meadow where knowledge grows,
A rabbit hops where the documentation flows.
With clearer paths for all to see,
Installing Teams is now a breeze!
Cloud credentials, easy to share,
With guides and tips, we show we care! 🐇✨

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

docs/source/teams/installation.rst (1)

Line range hint 1-24: Consider adding a troubleshooting section

Since the installation command has been problematic, it would be helpful to add a "Troubleshooting" section that covers:

• Common installation issues and their solutions
• How to verify successful installation
• What to do if the TOKEN is invalid or expired
• Steps to upgrade from a broken installation

This would help users diagnose and resolve installation problems more efficiently.

Would you like me to help draft content for a troubleshooting section?

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2ac993c and e5ab40f.

📒 Files selected for processing (1)

• docs/source/teams/installation.rst (1 hunks)

[coderabbitai]

⚠️ Potential issue

Correct fix for the shell variable syntax!

The change from {$TOKEN} to ${TOKEN} fixes the installation command by using the proper shell variable expansion syntax. This explains why the teams install command was broken, as the previous syntax would not correctly expand the TOKEN environment variable.