doc: Add categories and preview page workflow for the napari hub #489
Conversation
|
As DESCRIPTION.md is needed and PartSeg does not contain this file I try to add basic file to this PR but You do not allow tu push maintainert to this branch. Did you prefer to change this, or I should open my PR basic on this one? |
🤔 it looks like you should have access... |
|
ok. It was problem with |
|
awesome :D edit and merge as you see fit! |
|
why CITATION.cff is required? Is there any place where all requirements are described? |
|
Preview page for your plugin is ready here: |
|
Preview page for your plugin is ready here: |
it shouldn't be required... did a "missing" warning pop up? if so, that's a bug and we should prevent that.
the only "required" items are the ones that are listed in the checkbox at the top of the preview.... we can get them added |
|
Preview page for your plugin is ready here: |
|
@Czaki can you make a small change to re-trigger the build and confirm that chanzuckerberg/napari-hub#381 fixed the issue? |
|
or you might be able to just re-run the failed action? |
|
Preview page for your plugin is ready here: |
|
@neuromusic I just rerun action before adding description and citation and as you could see it pass (the last preview is from this action). |
|
Wideo1: 2022-01-12.14-04-13.mp4 |
|
Preview page for your plugin is ready here: |
|
Preview page for your plugin is ready here: |
|
Preview page for your plugin is ready here: |
|
Preview page for your plugin is ready here: |
Sourcery Code Quality ReportMerging this PR leaves code quality unchanged.
Here are some functions in these files that still need a tune-up:
Legend and ExplanationThe emojis denote the absolute quality of the code:
The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request. Please see our documentation here for details on how these metrics are calculated. We are actively working on this report - lots more documentation and extra metrics to come! Help us improve this quality report! |
|
Preview page for your plugin is ready here: |
Codecov Report
@@ Coverage Diff @@
## develop #489 +/- ##
========================================
Coverage 76.89% 76.89%
========================================
Files 144 144
Lines 18591 18591
========================================
Hits 14296 14296
Misses 4295 4295
Continue to review full report at Codecov.
|
|
Thanks for this. |
|
New description (with categories etc) landed on napari hub pages. https://www.napari-hub.org/plugins/PartSeg Thanks for your work. |
Hi Grzegorz
I’m reaching out with this pull request to ask for your help preparing your plugin for a new “Filter by Category” feature we’ll be launching for the napari hub near the end of January.
This PR does 2 things:
.napari/config.ymlto help users find your plugin.github/workflows/plugin_preview.ymlto help you preview changes to your plugin’s napari hub pageWhat is the “Filter by Category” feature?
We will let users filter plugins on the napari hub by Category, based on your own annotations of your plugin selected fro terms in the EDAM Bioimaging ontology. You are able to specify, in your
.napari/config.ymlfile, any number of EDAM labels at whatever depth of the taxonomy is most appropriate. You can see a mockup of this feature belowWe currently support viewing category metadata on the individual plugin pages, but before we let users filter by category, we want to get categories populated for as many plugins as possible.
For more information, see A plugin developer’s guide to categories on the napari hub.
Can you make adding category labels to my plugin easier?
Totally. We know that learning about the EDAM Bioimaging ontology and adding relevant categories is a lot of work. So we took a first pass for you!
To help you get started, our team has reviewed your plugin’s description and metadata and identified category labels that we feel would be a good fit based on the information you’ve provided so far. These were proposed initially by our Biocuration Team who are experts in annotating scholarly literature with biological concepts, then reviewed by my colleague, @chili-chiu, an Application Scientist on our team.We did our best to select relevant labels, but we might be wrong! Please review and edit these categories to best fit your plugin… and let us know how we did! We’re exploring ways that we might be able to automate suggestions in the future for new plugin developers. We’ll be launching the “Filter by Category” feature on Jan 27, 2022, so if you’d like to take advantage of this new feature, please merge this PR by then!
Can you let me preview the changes before I merge this PR?
Yeah, we can do that… not just for categories, but for all of your metadata!
To make it easier for you to update and maintain your plugin’s metadata, and see immediately how changes to links or your description will affect your napari hub listing, we’ve launched a new service that lets you preview your plugin’s page directly from PRs onto your plugin repository (like this one) and see what metadata you might be missing.
This service has two parts:
To use the new Preview Page feature, you simply need to install the Github App by clicking here and configuring it for this repository. Once you do that, make any update to this PR and you will get a comment from the @napari-hub-bot below with a link to your preview page!
For more information, see Setting Up Plugin Page Previews
We hope that these new features are useful to you! Happy to answer any questions here or on our Discussions page.