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

User group documentation #4106

Merged
merged 9 commits into from
Mar 7, 2024
Merged

User group documentation #4106

merged 9 commits into from
Mar 7, 2024

Conversation

lanzhenw
Copy link
Contributor

@lanzhenw lanzhenw commented Feb 26, 2024

What changes are proposed in this pull request?

Add documentation of user groups

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

Screen.Recording.2024-02-28.at.10.09.54.AM.mov

(Details)

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

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

@lanzhenw lanzhenw requested review from ritch, brimoor and manivoxel51 and removed request for ritch, brimoor and manivoxel51 February 26, 2024 19:10
@lanzhenw lanzhenw changed the title User group documentation [wip] User group documentation Feb 26, 2024
Copy link

codecov bot commented Feb 26, 2024

Codecov Report

Attention: Patch coverage is 25.49669% with 225 lines in your changes are missing coverage. Please review.

Project coverage is 16.01%. Comparing base (a4d5e31) to head (1fa9d59).
Report is 2 commits behind head on develop.

❗ Current head 1fa9d59 differs from pull request most recent head 62a0278. Consider uploading reports for the commit 62a0278 to get more accurate results

Files Patch % Lines
...pp/packages/looker/src/overlays/classifications.ts 6.12% 46 Missing ⚠️
app/packages/utilities/src/constants.ts 0.00% 40 Missing ⚠️
...ckages/looker/src/worker/threed-label-processor.ts 0.00% 28 Missing ⚠️
app/packages/looker/src/overlays/index.ts 35.13% 24 Missing ⚠️
app/packages/looker-3d/src/overlays/loader.ts 0.00% 23 Missing ⚠️
app/packages/looker/src/overlays/util.ts 11.76% 15 Missing ⚠️
app/packages/looker/src/zoom.ts 30.00% 14 Missing ⚠️
app/packages/looker/src/lookers/video.ts 26.66% 11 Missing ⚠️
app/packages/core/src/useFlashlightPager.ts 0.00% 8 Missing ⚠️
app/packages/looker-3d/src/Looker3d.tsx 0.00% 8 Missing ⚠️
... and 5 more
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4106      +/-   ##
===========================================
+ Coverage    15.98%   16.01%   +0.03%     
===========================================
  Files          732      734       +2     
  Lines        82054    82217     +163     
  Branches      1110     1119       +9     
===========================================
+ Hits         13115    13167      +52     
- Misses       68939    69050     +111     
Flag Coverage Δ
app 16.01% <25.49%> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lanzhenw lanzhenw self-assigned this Feb 27, 2024
Copy link
Contributor

@manivoxel51 manivoxel51 left a comment

Choose a reason for hiding this comment

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

Nice work Lanny! 🍨

Besides the inline comments,

  • I remember you wanting to use the latest screenshots with the latest avatar changes. Can we update the screenshots with those recent ones?

  • For later: It makes me think we should change the query in the Share Modal component and get the combined list of users/groups (first N) and show both user and group avatars.

docs/source/teams/roles_and_permissions.rst Outdated Show resolved Hide resolved
docs/source/teams/roles_and_permissions.rst Outdated Show resolved Hide resolved
docs/source/teams/roles_and_permissions.rst Outdated Show resolved Hide resolved
docs/source/teams/roles_and_permissions.rst Outdated Show resolved Hide resolved
@lanzhenw lanzhenw changed the title [wip] User group documentation User group documentation Feb 28, 2024
Copy link
Contributor

@brimoor brimoor left a comment

Choose a reason for hiding this comment

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

@lanzhenw this is looking good! Just left a few minor copy suggestions

docs/source/teams/index.rst Outdated Show resolved Hide resolved
docs/source/teams/index.rst Outdated Show resolved Hide resolved
docs/source/teams/index.rst Outdated Show resolved Hide resolved
docs/source/teams/roles_and_permissions.rst Outdated Show resolved Hide resolved
docs/source/teams/roles_and_permissions.rst Outdated Show resolved Hide resolved
docs/source/teams/roles_and_permissions.rst Outdated Show resolved Hide resolved
docs/source/teams/roles_and_permissions.rst Outdated Show resolved Hide resolved
docs/source/teams/roles_and_permissions.rst Outdated Show resolved Hide resolved
docs/source/teams/roles_and_permissions.rst Outdated Show resolved Hide resolved
docs/source/teams/roles_and_permissions.rst Outdated Show resolved Hide resolved
@lanzhenw lanzhenw requested a review from brimoor March 6, 2024 16:49
@lanzhenw lanzhenw changed the base branch from develop to release/v0.23.6 March 6, 2024 16:50
@lanzhenw lanzhenw requested review from a team as code owners March 6, 2024 16:50
@lanzhenw lanzhenw changed the base branch from release/v0.23.6 to develop March 6, 2024 16:51
@lanzhenw lanzhenw changed the base branch from develop to release/v0.23.6 March 6, 2024 16:55
@lanzhenw lanzhenw changed the base branch from release/v0.23.6 to develop March 6, 2024 16:55
@lanzhenw lanzhenw changed the base branch from develop to release/v0.23.6 March 6, 2024 17:02
@lanzhenw lanzhenw changed the base branch from release/v0.23.6 to merge/v0.23.6-to-main March 6, 2024 17:09
Base automatically changed from merge/v0.23.6-to-main to main March 6, 2024 20:06
@lanzhenw lanzhenw changed the base branch from main to develop March 6, 2024 21:06
@lanzhenw lanzhenw changed the base branch from develop to main March 6, 2024 21:10
@lanzhenw lanzhenw changed the base branch from main to develop March 6, 2024 21:13
@lanzhenw lanzhenw changed the title User group documentation [hold] User group documentation Mar 6, 2024
@brimoor brimoor changed the title [hold] User group documentation User group documentation Mar 6, 2024
Copy link
Contributor

@brimoor brimoor left a comment

Choose a reason for hiding this comment

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

LGTM. Very nice! 🍨

@brimoor brimoor merged commit b163fdd into develop Mar 7, 2024
@brimoor brimoor deleted the groupDoc branch March 7, 2024 04:47
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