Create publiccode.yml as prerequisite to be listed in the EU Open Source Solutions Catalogue

Help / Discuss
1

publiccode.yml is a metadata standard for repositories containing software developed or acquired by the Public Administration, aimed at making them easily discoverable and thus reusable by other entities. While this is not true for XWiki, it is being used by many public administrations all over Europe. Therefore, I suggest to make a publiccode.yml file available in order to make XWiki listed in the EU Open Source Solutions Catalogue.

See also this example: https://github.com/opf/openproject/blob/dev/publiccode.yml

There is also an yml-file–editor: https://publiccode-editor.developers.italia.it/ and a PR with a suggested file: Add publiccode.yml for XWiki application details by krabina · Pull Request #5352 · xwiki/xwiki-platform · GitHub

2

Thanks @krabina,

Out of curiosity, do you have examples of who is currently consuming this standard? And for what?

In all cases +1 as the idea looks interesting.

Then, as @vmassol pointed out in the PR, we need to be mindful of the maintenance of this file as many fields can easily become deprecated (e.g., used by, or screenshots), or very hard to fill exhaustively (e.g., depends on, or localisation).

We’ll probably also need to agree on who can be listed in the maintenance field, but it’s probably the same as Sponsoring Companies.

For the description, we can probably start with an English version and let the community complete with translations.

And for the version, this is probably something we can automate as part of the release.

3

Hi @krabina

Thanks a lot for proposing to use the publiccode.yml format, which I was unaware of. I think it’s a very good idea.

I’m all for using it and have left some comments in the PR that we need to resolve to reduce maintenance as much as possible.

Are there ways in the publiccode format to provide links to xwiki.org where to find exhaustive information rather than duplicate the information in the file itself? Specific examples:

Or maybe we could list a few items in each field and have the last field be something like:
... See https://xwiki.org/... for more. This could fit the “features” field for ex.

Same for usedBy.

For the availableLanguages field, maybe we just need to fill it and review once a year or something like that. A bit similar to what we do for updating the existing translations on wikimatrix (see XWiki Features | WikiMatrix ).

@krabina Are you going to update the PR based on the received comments? What’s your plan?

Thanks again :slight_smile:

4

Sounds like a good idea indeed.

But not everything is that easy to fill indeed.

Judging by openproject/publiccode.yml at dev · opf/openproject · GitHub, it seems exhaustivity is not too critical. But we would still need to make sure it does not contain stuff which are not true anymore.

It’s outdated by the way :slight_smile: (missing en_GB)