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

Third-party tools additions #247

Open
sbesson opened this issue May 27, 2022 · 1 comment
Open

Third-party tools additions #247

sbesson opened this issue May 27, 2022 · 1 comment
Assignees
Milestone

Comments

@sbesson
Copy link
Member

sbesson commented May 27, 2022

Potential candidate for adding to the list of third-party tools consuming Bio-Formats https://docs.openmicroscopy.org/bio-formats/latest/users/index.html

@sbesson sbesson changed the title Third-party Bio-Formats extension Third-party tools additions May 27, 2022
@dgault dgault added this to the 6.10.1 milestone Jun 20, 2022
@dgault dgault modified the milestones: 6.10.1, 6.10.2 Aug 11, 2022
@dgault dgault modified the milestones: 6.11.0, 6.11.1 Oct 12, 2022
@dgault dgault modified the milestones: 6.11.1, 6.12.0 Nov 30, 2022
@dgault dgault modified the milestones: 6.12.0, 6.12.1 Feb 14, 2023
@dgault dgault modified the milestones: 6.12.1, 6.13.1 Apr 25, 2023
@dgault dgault modified the milestones: 6.13.1, 7.0.0 Jul 5, 2023
@dgault dgault modified the milestones: 7.0.0, 7.0.1 Jul 31, 2023
@melissalinkert melissalinkert assigned sbesson and unassigned dgault Sep 16, 2024
@melissalinkert melissalinkert modified the milestones: 7.0.1, 8.0.0 Sep 16, 2024
@sbesson
Copy link
Member Author

sbesson commented Feb 21, 2025

A few thoughts related to this issue and motivated by the discussions in #84.

The User information includes a lot of content about third-party integrations. Most of it has been inherited from a previous iteration of the Bio-Formats documentation over a decade ago which was maintained as a wiki. It is fair to say we haven't significantly expanded this section or even adjusted the workflow. As we are talking about additions/modification/deletions and there are growing discussions about the policy for community contributions, this feels fairly timely

There are a few issues with the way third-party tools are maintained in this documentation. Probably most of these stem from the fact that these integrations are neither developed nor tested by the Bio-Formats maintainer team.

  • as noted in Review minimal MATLAB version #83, several of these integrations might be in a stale state because the integration or even the application itself is no longer developed, supported or maintained
  • the content of these individual pages usually includes a description of the application as well as installation instructions for the integration and is hard to maintain

Moving forward, my inclination would be to extract this third-party tooling content from the reference Bio-Formats documentation as follows:

  • define the set of user facing tool that are officially maintained, tested and supported. Currently, I would define these as the command-line utilities, the Fiji/ImageJ plugin and the MATLAB toolbox
  • extract all the content of the user documentation that does not meet this criterion to a new location to be determined e.g. a GitHub repository and/or a website registering third-party Bio-Formats integrations. In its simplest form, this could start as a single Markdown table with linking to other pages giving additional content for the given applications
  • define the rules for managing the content of this third-party tools registry. As per the above, I would vote for not puttig this responsibility to Bio-Formats maintainers. If this content lives under the OME organization, probably a minimal amount of review should happen. Or it could live under a separate organization.
  • remove these items from the reference documentation and include a link to these third-party tools

There have been a few attempts at organizing community documentation in the past e.g. https://github.com/ome/community-docs. In a similar vein, for OMERO, several third-party integrations have been migrated to https://omero-guides.readthedocs.io/. We should definitely build on the successes and failures of these experiences and ideally find a solution that aligns with the management of the OME training materials /cc @jburel @pwalczysko

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

No branches or pull requests

3 participants