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

Maintain meta data of OpenRail projects #106

Closed
cornelius opened this issue Aug 5, 2024 · 1 comment
Closed

Maintain meta data of OpenRail projects #106

cornelius opened this issue Aug 5, 2024 · 1 comment

Comments

@cornelius
Copy link
Member

There is a bit of data we need to maintain about OpenRail projects. These are basic things like name, description, important general data such as the license, but also some OpenRail specific data such as which architectural domain the project covers, the incubation stage.

Some of this data is already there, in the GitHub UI, in README or LICENSE files, or in the information around the incubation process. Some data is not there yet, e.g. the architectural domain.

We use this data for the presentation of the projects in various places, in the repository itself, in the project list maintained by the technical committee. We also want to use it on the web site (#95). Or in a bit more informal ways when talking about projects in presentations etc. There something like a summary sheet of the project would be helpful as well, which mostly will contain the meta data we have at other places as well.

To make this easier and consistent and serve the data from one canonical place, it would be good to adopt a common format and a standard location for maintaining this data.

One way this could be done is by adopting publiccode.yml. This is pretty close to what we need.

An alternative solution might be https://codemeta.github.io/.

@cornelius
Copy link
Member Author

We decided to go with publiccode.yml: https://github.com/OpenRailAssociation/landscape/tree/main/data/openrail. Works well so far. We use it to show the projects on the website: https://openrailassociation.org/#projects

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

1 participant