Add docs script

[benjaminpkane]

What changes are proposed in this pull request?

Adds clearbit script to docs

How is this patch tested? If it is not, please explain why.

Docs build

What areas of FiftyOne does this PR affect?

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

Summary by CodeRabbit

• Documentation

  • Enhanced website layout by consolidating meta tags.
  • Added new external script and GitHub buttons script.
  • Updated Google Analytics script.
  • Refined formatting for anchor tags and buttons.
  • Adjusted menu items under "Products," "Community," and "About Us."

• Chores

  • Updated artifact upload path in workflow to include .tar.gz files.
  • Increased package version to 1.1.4 and added MongoDB links for new architectures.

[coderabbitai]

Walkthrough

The changes primarily focus on refining the process of artifact upload, enhancing the documentation layout, and updating the setup for a database package. Specifically, these include filtering specific file types for artifact uploads, improving the HTML structure of the documentation, and updating MongoDB version details in the database setup script.

Changes

File	Summary
.github/workflows/build-db.yml	Adjusted to only include .tar.gz files for sdist platform artifact uploads, excluding other file types.
docs/source/_templates/layout.html	Enhanced meta tags, added external scripts, adjusted list items, formatted tags and buttons, updated analytics and GitHub button scripts.
package/db/setup.py	Added MongoDB version "24" details and updated the package version from "1.1.3" to "1.1.4".

Poem

In a burrow deep, where codes entwine,
Updates sparkle, databases shine.
New scripts and buttons for all to see,
Version twenty-four greets thee!
Analytics and stars now align,
A digital warren, so divine. 🌟🐇

Warning

Review ran into problems

Problems (1)

• Git: Failed to clone repository. Please contact CodeRabbit support.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e9f2fbf and af79459.

Files selected for processing (3)

• .github/workflows/build-db.yml (1 hunks)
• docs/source/_templates/layout.html (7 hunks)
• package/db/setup.py (2 hunks)

Files skipped from review due to trivial changes (1)

• docs/source/_templates/layout.html

Additional comments not posted (3)

.github/workflows/build-db.yml (1)

72-72: LGTM!

The change to refine the artifact upload path to include only .tar.gz files for the sdist platform is appropriate.

package/db/setup.py (2)

98-101: LGTM!

The addition of MongoDB version "24" download links for different architectures is consistent and necessary for supporting the new version.

---

146-146: LGTM!

The version update from "1.1.3" to "1.1.4" is appropriate to reflect the new changes in the package.

[findtopher]

😋

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

docs/source/_templates/layout.html (1)

2-2: Add alt attribute to the meta tag.

The meta tag should include an alt attribute for accessibility.

- <meta property="og:image" content="{{og_image}}" />
+ <meta property="og:image" content="{{og_image}}" alt="Open Graph Image" />

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between af79459 and 0acdadc.

Files selected for processing (1)

• docs/source/_templates/layout.html (7 hunks)

Additional comments not posted (9)

docs/source/_templates/layout.html (9)

12-12: Ensure the Clearbit script is necessary and secure.

Verify that the Clearbit script is necessary for your documentation and that it doesn't introduce any security vulnerabilities.

---

44-47: Verify the correctness of the new links.

Ensure the new links in the "Products" section are correct and lead to the intended pages.

---

57-59: Verify the correctness of the new links.

Ensure the new links in the "Community" section are correct and lead to the intended pages.

---

73-75: Verify the correctness of the new links.

Ensure the new links in the "About Us" section are correct and lead to the intended pages.

---

93-94: Ensure the GitHub star button attributes are correct.

Verify that the GitHub star button attributes are correctly set and functional.

---

98-98: Ensure the new button is correctly formatted.

Verify that the new button for scheduling a workshop is correctly formatted and functional.

---

192-192: Ensure the GitHub buttons script is necessary and secure.

Verify that the GitHub buttons script is necessary for your documentation and that it doesn't introduce any security vulnerabilities.

---

195-200: Ensure the Google Analytics script is necessary and secure.

Verify that the Google Analytics script is necessary for your documentation and that it doesn't introduce any security vulnerabilities.

---

Line range hint 204-238:
Ensure the BigPicture.io script is necessary and secure.

Verify that the BigPicture.io script is necessary for your documentation and that it doesn't introduce any security vulnerabilities.