imagej/list-of-update-sites

The update sites ImageJ2 knows about automatically

List of Update Sites

In ImageJ2, anyone can open the Updater and install features from a list of available update sites which is populated by this repository.

Adding / Editing / Removing an Update Site

If you want to add, edit, or remove an update site from this list, please create a pull request.

1. Fork this repository
2. Modify sites.yml in your fork
3. Create a pull request containing your changes

Before adding a new site, please create a wiki page:

• If your site primarily ships plugins, then for each plugin, use: https://imagej.net/plugins/your-plugin-name-in-web-case
• If you want a dedicated page about your update site itself (perhaps linking to all the plugins it offers), use: https://imagej.net/update-sites/your-update-site-name-in-web-case

Need help? Don't worry, and post your question on the Image.sc Forum!

list-of-update-sites's Issues

Safeguard against markdown in site names

In 5bc911a we noticed that site names containing multiple underscores (_) will be parsed as italics when generating https://imagej.net/list-of-update-sites/, which then results in the underscores not being present in the URL and the site being invalid in an active IJ installation.

We should:

• Parse URLs as raw text, or markdown formatting should be automatically escaped
• Update the README.md with consistent site naming guidelines perhaps?

Add ID to update site list entry

Each update site entry should have an ID.
Motivation:

• the updater can use it to match entries even if the user changed the URL of the update site locally
• we can define mirror lists where IDs can be linked to different URLs

Test PRs with CI

As #90 demonstrates, we are not actually running validation of sites.yml and other correctness tests on PRs, only on the main branch. We need to change that.

Mirror lists

Imagine there is a base list (e.g. sites.yml) and a directory called mirrors where people could add mirror servers. One mirror file would contain something like this:

• a list containing IDs of update sites linked to the URLs of their servers
• if they mirrored sites.imagej.net, it would contain the replacement for this path as well
• the location of the mirror server

The updater could then provide the user with a choice to pick from depending on their location.

Fix HTML markup

Since upgrading the imagej.net MediaWiki version, the appearance of this site is now weird. Looking at the HTML, I see a bunch of PHP cruft that was copy-pasted from the original "List of update sites" wiki page. I guess I was sloppy/incomplete in porting it over to GitHub Pages. This needs to be cleaned up and fixed!