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

Updated, self-maintained resource to list exhaustively existing remote modules #4786

Open
jhlegarreta opened this issue Jul 20, 2024 · 3 comments
Labels
Good first issue A good issue for community members new to contributing type:Documentation Documentation improvement or change

Comments

@jhlegarreta
Copy link
Member

Description

There is currently no updated, self-maintained resource to list exhaustively existing remote modules. The ITK remote group in the Doxygen documentation:
https://itk.org/Doxygen/html/group__Group-Remote.html

Does not contain the 60+ remotes that have been identified in:
#4748

So it is difficult to know how many and which are the remote modules that can be used with/available to ITK.

Expected information

Have an updated, self-maintained list of all existing ITK remote modules (regardless of their integration stage into the ITK remotes folder). Their integration or status should also be made clear in that resource: this may be drawn automatically (at least partially) from the *remote.cmake file of those files for the ones that are included in the ITK Remote group.

Actual information

No resource is available that lists all existing ITK remotes.

Versions

master.

Additional Information

None.

@jhlegarreta jhlegarreta added type:Documentation Documentation improvement or change Good first issue A good issue for community members new to contributing labels Jul 20, 2024
@thewtex
Copy link
Member

thewtex commented Jul 23, 2024

The itk-module GitHub repository tag is a good way for repositories to self-identify. It currently lists 74 repositories.

https://github.com/topics/itk-module

We could dynamically generate a page in our docs.itk.org documentation based on those results.

@jhlegarreta
Copy link
Member Author

The itk-module GitHub repository tag is a good way for repositories to self-identify. It currently lists 74 repositories.

Can be one way, but there is probably more work that is needed:

@jhlegarreta
Copy link
Member Author

Besides listing all remotes in a single location, it would be useful to be able to monitor their CI build status from a single location as well. It looks like no dashboard machine currently offers this information, as only some "Favorite" remotes are being listed, e.g.
https://open.cdash.org/index.php?project=Insight&date=2024-10-05 (Expected Nightly Remote Modules)

with only a handful of the remotes being set to ON:
https://open.cdash.org/builds/9944151/notes#note0

An easy solution would be to create a repository or other documentation page where all remotes are listed as a table, with a column that shows their CI build status badge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good first issue A good issue for community members new to contributing type:Documentation Documentation improvement or change
Projects
None yet
Development

No branches or pull requests

2 participants