Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge/v0.25.0 to develop #4706

Merged
merged 17 commits into from
Aug 20, 2024
Merged

Merge/v0.25.0 to develop #4706

merged 17 commits into from
Aug 20, 2024

Conversation

findtopher
Copy link
Member

@findtopher findtopher commented Aug 20, 2024

What changes are proposed in this pull request?

Merge final 0.25.0 changes into develop

Summary by CodeRabbit

  • New Features

    • Introduced new plugin for creating custom dashboards in the app.
    • Added permission for tagging samples and labels without editing rights.
    • Enhanced dataset cloning to include saved views and workspaces.
    • Added new Audit page for Super Admins to monitor license utilization.
    • Expanded management SDK with group management functionalities.
  • Bug Fixes

    • Resolved issues related to user roles and recent views.
    • Improved 3D asset rendering performance.
  • Documentation

    • Updated documentation for enhanced clarity and consistency in naming conventions.
    • Introduced section for deprecation notices for better organization.
  • Chores

    • Version updated to reflect new features and improvements.

Copy link
Contributor

coderabbitai bot commented Aug 20, 2024

Walkthrough

The recent updates encompass a variety of improvements across documentation and codebase components, enhancing clarity, organization, and functionality. Key changes include standardizing naming conventions, refining instructional text, enriching documentation with new features, and improving user management capabilities. These modifications aim to optimize the user experience, ensure compliance with standards, and foster better engagement with the FiftyOne framework.

Changes

Files Change Summary
SchemaIO/components/DashboardView.tsx Minor textual adjustments for consistency in capitalization and instructional text in the user interface.
docs/source/_templates/layout.html Replaced self-closing <script> tags with proper opening and closing <script> tags to comply with HTML standards.
docs/source/deprecation.rst Added a new section header for deprecation notices to enhance documentation structure.
docs/source/plugins/developing_plugins.rst Updated class names and labels for consistency, minor method adjustments, and improved responsive design principles in plugin documentation.
docs/source/plugins/index.rst Introduced a new plugin entry for creating custom dashboards, enhancing user options within the FiftyOne platform.
docs/source/release-notes.rst Highlighted significant updates in Teams 2.0.0 release, including new permissions, performance enhancements, and user management improvements.
docs/source/teams/management_sdk.rst Made minor textual modifications for consistency and added a section on group management functionalities.
fiftyone/operators/__init__.py Imported ExecutionContext to enhance functionality within the operators module.
package/db/setup.py Added MongoDB download URLs for various Ubuntu versions and made a case-insensitivity improvement in download URL retrieval logic; incremented version number.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Dashboard as Custom Dashboard
    participant Plugin as Plugin System

    User->>Plugin: Request to create custom dashboard
    Plugin->>Dashboard: Initialize dashboard creation
    Dashboard-->>User: Display dashboard interface
    User->>Dashboard: Add components to dashboard
    Dashboard-->>User: Show updated dashboard
Loading

🐇 In the land of code where changes bloom,
A dashboard now brings joy to the room.
With tidy names and clearer text,
Our users rejoice, what comes next?
Plugins delight, as options expand,
A happier world, all crafted by hand! 🌼


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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (3)
docs/source/release-notes.rst (3)

14-15: Clarify the "Can tag" permission description.

The description of the "Can tag" permission could be more explicit about what "tagging" entails and how it differs from other editing capabilities.

Consider rephrasing to clarify the specific actions allowed by this permission.

- Added a :ref:`Can tag <teams-can-tag>` permission to allow users to tag
- samples/labels but not otherwise perform edits
+ Added a :ref:`Can tag <teams-can-tag>` permission to allow users to add tags
+ to samples/labels without granting broader editing capabilities

18-19: Clarify plugin execution description.

The description of plugin execution being "user-aware" could be expanded to specify what "user-aware" means in this context.

Consider providing more detail about the implications of this change.

- All :ref:`plugin execution <teams-plugins>` is now user-aware and will
- respect the executing user’s role and dataset permissions
+ All :ref:`plugin execution <teams-plugins>` is now user-aware, meaning that
+ it will respect the executing user’s role and dataset permissions, ensuring
+ that plugins operate within the user's access rights

63-66: Clarify Python panels description.

The description of Python panels could be expanded to specify the benefits or use cases for this feature.

Consider providing more context about how Python panels enhance user experience.

- Introducing :ref:`Python panels <developing-panels>`, a powerful framework for
- building custom App panels via a simple Python interface that includes a
- wealth of builtin components to convey information, create tutorials, show
- interactive graphs, trigger operations, and more
+ Introducing :ref:`Python panels <developing-panels>`, a powerful framework for
+ building custom App panels via a simple Python interface. This feature
+ includes a wealth of builtin components to convey information, create
+ tutorials, show interactive graphs, trigger operations, and more, enhancing
+ the flexibility and interactivity of the App
Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f88f108 and 221654f.

Files ignored due to path filters (1)
  • docs/source/images/plugins/panels/dashboard-panel.gif is excluded by !**/*.gif, !**/*.gif
Files selected for processing (9)
  • app/packages/core/src/plugins/SchemaIO/components/DashboardView.tsx (2 hunks)
  • docs/source/_templates/layout.html (2 hunks)
  • docs/source/deprecation.rst (1 hunks)
  • docs/source/plugins/developing_plugins.rst (13 hunks)
  • docs/source/plugins/index.rst (2 hunks)
  • docs/source/release-notes.rst (1 hunks)
  • docs/source/teams/management_sdk.rst (3 hunks)
  • fiftyone/operators/init.py (1 hunks)
  • package/db/setup.py (3 hunks)
Files skipped from review due to trivial changes (4)
  • app/packages/core/src/plugins/SchemaIO/components/DashboardView.tsx
  • docs/source/_templates/layout.html
  • docs/source/deprecation.rst
  • docs/source/teams/management_sdk.rst
Additional context used
Ruff
fiftyone/operators/__init__.py

17-17: .executor.ExecutionContext imported but unused; consider removing, adding to __all__, or using a redundant alias

(F401)

Additional comments not posted (8)
docs/source/plugins/index.rst (1)

44-45: New plugin entry for @voxel51/dashboard looks good.

The addition of the @voxel51/dashboard plugin entry is well-formatted and consistent with existing documentation entries. It enhances the documentation by providing users with more options for customization.

Also applies to: 85-90

package/db/setup.py (3)

68-89: New MongoDB download URLs for Ubuntu versions under "pop" look good.

The addition of download URLs for various architectures and Ubuntu versions enhances the functionality to support additional environments.


145-145: Case-insensitive key lookup in _get_linux_download() is a good improvement.

Changing the dictionary key to d["ID"].lower() ensures robustness by preventing potential mismatches due to case sensitivity.


168-168: Version increment to 1.1.5 is appropriate.

The version update reflects the inclusion of new download URLs and improvements in the logic.

docs/source/plugins/developing_plugins.rst (4)

2474-2479: Renaming to DropdownMenuExample and method improvements look good.

The renaming of DropdownMenuPanel to DropdownMenuExample and the addition of the variant parameter in say_hi improve clarity and consistency.

Also applies to: 2495-2509


2597-2602: Interactive plot example improvements are well-implemented.

The renaming to InteractivePlotExample and the changes in method implementations enhance usability and readability. The _make_matching_view function provides a clear purpose.

Also applies to: 2608-2621, 2633-2637, 2663-2666, 2682-2682


2709-2714: Walkthrough example updates improve clarity and engagement.

The renaming to WalkthroughExample and the adjustments in layout and navigation enhance the user experience and clarity of the walkthrough.

Also applies to: 2748-2750


2853-2858: Image and media player examples are well-structured.

The renaming to ImageExample and MediaPlayerExample aligns with the new naming conventions, improving consistency and clarity.

Also applies to: 2915-2920

@@ -14,6 +14,7 @@
)
from .executor import (
execute_operator,
ExecutionContext,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Address the unused import of ExecutionContext.

The ExecutionContext is imported but not used in this file. Consider removing it, adding it to __all__, or using it in the code to avoid unnecessary imports.

-    ExecutionContext,
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.

Suggested change
ExecutionContext,
Tools
Ruff

17-17: .executor.ExecutionContext imported but unused; consider removing, adding to __all__, or using a redundant alias

(F401)

@findtopher findtopher merged commit da3ee83 into develop Aug 20, 2024
26 checks passed
@findtopher findtopher deleted the merge/v0.25.0-to-develop branch August 20, 2024 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants