Update links to napari hub docs #143
Conversation
According to https://github.com/chanzuckerberg/napari-hub/wiki/Customizing-your-plugin's-listing#github, support for .napari/ will be deprecated at some point in the future, so updating this documentation.
github-actions
bot
added
the
documentation
|
Hi @kandarpksk, the core dev team would actually like to deprecate metadata outside of |
|
Thanks @DragaDoncila, just read some of the discussion! Would you suggest...
|
There was a problem hiding this comment.
@kandarpksk I've left a couple of comments suggesting changes to the page text. Let me know what you think. We're very eager to get the hub guide and logic updated to point to standard sources of metadata wherever possible - once that's done we can update this page again to point to the relevant resources.
docs/plugins/test_deploy.md
Outdated
| @@ -119,14 +116,15 @@ development process, see the [napari hub GitHub’s | |||
| Wiki](https://github.com/chanzuckerberg/napari-hub/wiki). | |||
|
|
|||
| If you want your plugin to be available on PyPI, but not visible on the napari | |||
| hub, you can add a `.napari/config.yml` file to the root of your repository with | |||
| a visibility key. For details, see the [customization | |||
| hub, you can add a `.napari-hub/config.yml` file to the root of your repository | |||
There was a problem hiding this comment.
Here I'm torn as currently the only option for updating visibility on the hub is to add this field (or remove your framework classifier). However, we really want to encourage adoption of this field from the manifest instead. We need to add this to napari, and the napari hub should also change their logic to read this field instead. We can open PRs to plugins using config.yml as needed, to avoid a lengthy deprecation step. I think for now this change is fine though.
There was a problem hiding this comment.
I'm ambivalent about this change now, since regardless of what is said here, it's likely to change based on the discussion you referenced. The only advantage I guess is that it makes things consistent with the hub guide.
There was a problem hiding this comment.
@kandarpksk I've opened napari/#5879 to track the implementation of the visibility field in the plugin installer. I suggest we leave this bit of the docs as is until that's done, when we can update this section to refer to the manifest visibility field. If you update the PR to exclude the changes to this paragraph, I can go ahead and approve.
There was a problem hiding this comment.
I've excluded this change in the latest commit, and will update the PR title appropriately!
kandarpksk
changed the title
There was a problem hiding this comment.
@psobolewskiPhD thanks for the ping. This looks good to go in for me. Question for @kandarpksk - is the preview page being deprecated? I remember there being some discussion about that.
DragaDoncila
dismissed
their stale review
Ah wait, I see this doc has been split up now...
|
@psobolewskiPhD I've opened #336 to make these updates and also remove mention of the preview page. |
# References and relevant issues Supersedes #143. # Description This PR updates the links to the napari hub documentation about customizing a plugin's listing. It also removes mentions of the preview page, as the service has been [deprecated](chanzuckerberg/napari-hub#1216). <!-- Final Checklist - If images included: I have added [alt text](https://webaim.org/techniques/alttext/) If workflow, documentation build or deployment change: - My PR is the minimum possible work for the desired functionality - I have commented my code, to let others know what it does --> --------- Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com> Co-authored-by: Peter Sobolewski <76622105+psobolewskiPhD@users.noreply.github.com>
According to https://github.com/chanzuckerberg/napari-hub/wiki/Customizing-your-plugin's-listing#github, support for .napari/ will be deprecated at some point in the future, so updating this documentation.
PS: Also updated some links and made minor improvements on the test-and-deploy page.
PPS: The scope of this PR is now limited to what I've mentioned in the original postscript!