Add publiccode.yml for XWiki application details#5352
Add publiccode.yml for XWiki application details#5352krabina wants to merge 1 commit intoxwiki:masterfrom
Conversation
[[ https://yml.publiccode.tools/ | 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 [[ https://interoperable-europe.ec.europa.eu/eu-oss-catalogue | EU Open Source Solutions Catalogue ]] See also this examples: https://github.com/opf/openproject/blob/dev/publiccode.yml There is also an yml-file–editor: https://publiccode-editor.developers.italia.it/
|
Thanks @krabina ! Sounds interesting. Let me review the metadata you've proposed. Note that we'll need to add a license header. |
| applicationSuite: XWiki | ||
| url: https://github.com/xwiki | ||
| landingURL: https://www.xwiki.org/ | ||
| isBasedOn: https://www.xwiki.com/ |
There was a problem hiding this comment.
I think this one is not correct and should be removed.
We could add a fundedBy entry though and list XWiki SAS there.
| url: https://github.com/xwiki | ||
| landingURL: https://www.xwiki.org/ | ||
| isBasedOn: https://www.xwiki.com/ | ||
| softwareVersion: 18.1.0 |
There was a problem hiding this comment.
That's going to be painful to maintain as we'll need to change it every few weeks. We'll need to add it to the release plan application at https://dev.xwiki.org/xwiki/bin/view/ReleasePlans/ to not forget.
There was a problem hiding this comment.
Should not be too hard to update this (and releaseDate) in the release script I guess.
| landingURL: https://www.xwiki.org/ | ||
| isBasedOn: https://www.xwiki.com/ | ||
| softwareVersion: 18.1.0 | ||
| releaseDate: 2026-02-23 |
| isBasedOn: https://www.xwiki.com/ | ||
| softwareVersion: 18.1.0 | ||
| releaseDate: 2026-02-23 | ||
| logo: https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-flamingo/xwiki-platform-flamingo-skin/xwiki-platform-flamingo-skin-resources/src/main/resources/flamingo/logo.svg |
There was a problem hiding this comment.
I feel we should point to https://www.xwiki.org/xwiki/bin/view/Main/Logo or a specific logo from that page since the location in the sources is fragile (it could be moved around).
| - web-collaboration | ||
| - other | ||
| organisation: | ||
| uri: https://xwiki.com |
| organisation: | ||
| uri: https://xwiki.com | ||
| usedBy: | ||
| - Schleswik-Holstein |
There was a problem hiding this comment.
Not sure if we should use this field or not. Feels too hard to maintain and duplicate information with info from xwiki.org. Ideally we should instead point to https://www.xwiki.org/xwiki/bin/view/References (or https://www.xwiki.org/xwiki/bin/view/References/#HProjectList)
| localisedName: XWiki | ||
| shortDescription: "XWiki is a second-generation wiki. This means it's not only a traditional wiki, but also a powerful application development platform in its own right. XWiki can be used both as a classic wiki and as an application platform. An application in XWiki is a set of Pages that adds new functionality to the wiki, such as a blog or a task manager. You can also build your own applications, for instance, you could create a FAQ or an application to manage product sheets, without requiring programming skills. " | ||
| longDescription: "XWiki is a second-generation wiki. This means it's not only a traditional wiki, but also a powerful application development platform in its own right. While first-generation wikis focus on content collaboration (creating and editing pages together), second-generation wikis take this concept further by enabling users to build structured, collaborative web applications directly from within the wiki. XWiki can be used both as a classic wiki and as an application platform. An application in XWiki is a set of Pages that adds new functionality to the wiki, such as a blog or a task manager. You can also build your own applications, for instance, you could create a FAQ or an application to manage product sheets, without requiring programming skills. | ||
| This allows XWiki to be used for a variety of use cases, such as Projects Powered by XWiki." |
There was a problem hiding this comment.
We should probably review this desc but it's a good first start, thx!
| - Wiki | ||
| - Structured Wiki | ||
| - Input Forms | ||
| screenshots: |
There was a problem hiding this comment.
that's going to be a long list if we describe all the features. Ideally again, best would be to point to https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/
| screenshots: | ||
| - https://xwiki.com/en/features/ | ||
| videos: | ||
| - https://www.youtube.com/watch?v=8DePx30dh2g |
There was a problem hiding this comment.
Maybe we should remove this field for now as we don't have any recent of official video of XWiki that I know of. The video listed is 5 years old. To be reviewed.
| contacts: | ||
| - name: XWiki SAS | ||
| email: contact@xwiki.com | ||
| affiliation: XWiki SAS |
There was a problem hiding this comment.
We should put the contact of the XWiki Core committers (committers at xwiki dot org) instead.
| affiliation: XWiki SAS | ||
| localisation: | ||
| localisationReady: true | ||
| availableLanguages: |
There was a problem hiding this comment.
Needs to be synced with the info from https://www.xwiki.org/xwiki/bin/view/documentation/xs/admin/base/content-organization/administer-wiki/enable-multilingual-setting/#HFAQ (which automatically computed from the info from https://dev.xwiki.org/xwiki/bin/view/Community/L10N/SupportedLocales/WebHome).
Not easy to maintain.
|
This would require that a proposal be sent on the forum, in the Dev category: https://forum.xwiki.org/c/dev/13 |
|
yes, sorry if I did not follow any of the usual paths. I am new to XWiki development (no worries, I am no dev). I just thought I could as well just propose a .ymlf file instead of opening a question. |
|
@krabina yes and it's great, thx! If you want to pursue this, it would be great if you could open a proposal at https://forum.xwiki.org/c/dev/13 . If you can't do this, then I'll take it over when I get some time (but it would be best if you could do it since you're the creator of this idea :)). |
3 participants
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 examples: https://github.com/opf/openproject/blob/dev/publiccode.yml
There is also an yml-file–editor: https://publiccode-editor.developers.italia.it/