Organize integrations by category #3999
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
brimoor
force-pushed
the
docs/integrations-categories
branch
from
9dacc06
to
0992aed
Compare
brimoor
changed the title
| @@ -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 | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 | |||
There was a problem hiding this comment.
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)
brimoor
force-pushed
the
docs/integrations-categories
branch
from
9d2da7a
to
4efe6af
Compare
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:
Release Notes
Is this a user-facing change that should be mentioned in the release notes?
notes for FiftyOne users.
What areas of FiftyOne does this PR affect?
fiftyonePython library changes