Migrate and update hub customization from wiki to docs #906
Conversation
github-actions
bot
added
the
documentation
|
@jni since you requested this in napari/napari-plugin-template#128, pls review 😉 🙏 |
DragaDoncila
left a comment
DragaDoncila
left a comment
There was a problem hiding this comment.
@TimMonko so much great information here ❤️ A lot of it can be removed now that we're not using the .napari-hub/ folder and because we still are missing a lot of features on hub-lite 😭 I've left comments where appropriate.
|
|
||
| ## Field reference | ||
|
|
||
| This table summarizes where each field is displayed and how it's sourced: |
There was a problem hiding this comment.
Not sure how useful this table still is tbh. Everything comes from PyPI or manifest. Maybe it's worth editing down, but I'd also be happy to just remove it for now.
| - ❌ It won't appear on the napari hub | ||
| - ❌ It won't be automatically discovered by napari | ||
|
|
||
| If you want your plugin to remain installable with the napari plugin manager but not appear in search, use the `visibility: hidden` setting in your `napari.yaml` manifest instead. |
Co-authored-by: Draga Doncila Pop <[email protected]>
TimMonko
left a comment
TimMonko
left a comment
There was a problem hiding this comment.
Ok, oops, I just kinda went through all @DragaDoncila 's review and did one big massive commit. I think I have 1 or 2 things to address still, but thank you for the review and reminder to do this. Slipped my mind.
I need to look up the image thing for sure.
|
|
||
| ### Categories | ||
|
|
||
| Categories help users discover your plugin through filtering and search. The hub maps certain npe2 categories to "Workflow Steps": |
There was a problem hiding this comment.
then what is it for? I was definitely interpolating or it was in the wiki docs
Are Categories used for anything?
|
|
||
| ```toml | ||
| [project.urls] | ||
| Homepage = "https://github.com/username/napari-example-plugin" |
There was a problem hiding this comment.
I guess I'm not understanding this section https://github.com/chanzuckerberg/napari-hub/wiki/Customizing-your-plugin's-listing#project-site? Is it mostly just hopeful then? I know pypi uses these, I guess
|
Ok, now with instructions on how to get images and assets to render in READMEs :) This will certainly help me going forward, it's something I've wanted to figure out for a long time. This PR is greatly simplified now, about half as many LOC, so sorry that its a complete reorg. Should be an easier review now! |
|
|
||
| ```toml | ||
| [project.urls] | ||
| Homepage = "https://github.com/username/napari-example-plugin" |
There was a problem hiding this comment.
@TimMonko on the original implementation of the hub, each of these had their own dedicated field, similar to how it's displayed on pypi. Currently we only link to pypi and github. I'd be open to adding these back to the hub, although there has previously been philosophical discussion on how much information we should duplicate from e.g. pypi -- is the goal to provide all the same information + more, or is the goal to provide basic information + napari-specific stuff. I lean more towards the latter, but would be open to the former.
Currently sadly, no. They need to be displayed on hub. I've added an issue on hub-lite (and opened a couple of others prompted by this PR), and I've triaged all the open issues using the |
Co-authored-by: Draga Doncila Pop <[email protected]>
2 participants
References and relevant issues
napari/napari-plugin-template#128
Description
Plugins -> Testing and publishing. Is this the appropriate place, or should it be inBuilding a Plugin?