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

Organize integrations by category #3999

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

jacobmarks
Copy link
Contributor

@jacobmarks jacobmarks commented Jan 12, 2024

We have a ton of integrations, which is a great problem to have! To make it easier for users to find what they are looking for, this PR adds a subsection below Integrations, dividing everything into the categories:

  • Annotation
  • Datasets
  • Models
  • Vector Search

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.

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

Copy link

codecov bot commented Jan 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (17e7c82) 15.97% compared to head (4efe6af) 15.97%.
Report is 3 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3999   +/-   ##
========================================
  Coverage    15.97%   15.97%           
========================================
  Files          732      732           
  Lines        81957    81957           
  Branches      1101     1101           
========================================
  Hits         13092    13092           
  Misses       68865    68865           
Flag Coverage Δ
app 15.97% <ø> (ø)

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.

@brimoor brimoor force-pushed the docs/integrations-categories branch from 9dacc06 to 0992aed Compare January 15, 2024 20:21
@brimoor brimoor changed the title [DOCS] Add categories for integrations Organize integrations by category Jan 15, 2024
@brimoor brimoor changed the base branch from develop to release/v0.23.3 January 15, 2024 21:13
@brimoor brimoor changed the base branch from release/v0.23.3 to develop January 15, 2024 21:14
@@ -20,3 +20,26 @@ user_guide/dataset_creation/common_datasets.rst user_guide/dataset_creation/dat
# Introduced in v0.2
examples/dataset_creation.rst user_guide/dataset_creation/datasets.rst
examples/index.rst tutorials/index.rst

# Introduced in v0.24
Copy link
Contributor

Choose a reason for hiding this comment

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

It's critical to ensure that any existing links like https://docs.voxel51.com/integrations/coco.html that may exist out in the world continue to exist after this change. Fortunately, we have this redirects file to include redirects to the new pages in the build process.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah you are absolutely right. I somehow missed this and thought that none of the links were broken. Total gaffe on my part.

@@ -37,126 +36,126 @@ on the cards below to see how!
.. customcarditem::
:header: COCO Dataset
:description: See how FiftyOne makes downloading, visualizing, and evaluating on the COCO dataset (or your own COCO-formatted data) a breeze.
:link: coco.html
:link: datasets/coco.html
Copy link
Contributor

Choose a reason for hiding this comment

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

One drawback of this new format is that new integration cards must be added in two different places.

Also, if we add an integration that doesn't fit in any of the existing categories, we'll need to add an Other section to the sidebar, or else people that only use the sidebar to find pages may not realize that the new integration page even exists (personally I never use the cards, so I'd be in that boat)

docs/source/integrations/models/index.rst Outdated Show resolved Hide resolved
@brimoor brimoor force-pushed the docs/integrations-categories branch from 9d2da7a to 4efe6af Compare January 23, 2024 23:10
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.

2 participants