Add fields for users/maintainers in recipes.json / recipe metadata? #307

Open
opened 2022-04-01 10:45:58 +00:00 by decentral1se · 2 comments
Owner

Right now on https://recipes.coopcloud.tech/recipes.json (which will soon have a web UI @ https://recipes.coopcloud.tech) you can't tell who is using the recipe & who is maintaining the recipe.

This would be super useful to have in the JSON blob with a name & potentially contact details (matrix handle, email?) so that people considering to use the recipe could get in touch with those already using it and/or taking care of it!

This would help facilitate more direct connects between potential users/maintainers. People could just freely get in touch & see how to best to co-operate on keeping the recipe going.

How would this work?

  1. we need to add a new format to the recipe READMES. e.g. in bca2a983c0/README.md alongside the Category, Status, etc.
  2. we need to teach abra to parse that and add it to the recipes.json
  3. we need to get this into the design of the new web UI for the catalogue

Proposals for README format?

* **Users**: <autonomic helo@autonomic.zone>, <othercoop helo@othercoop.com>
* **Maintainers**: <autonomic helo@autonomic.zone>

/cc @3wordchant

Right now on https://recipes.coopcloud.tech/recipes.json (which will soon have a web UI @ https://recipes.coopcloud.tech) you can't tell who is using the recipe & who is maintaining the recipe. This would be super useful to have in the JSON blob with a name & potentially contact details (matrix handle, email?) so that people considering to use the recipe could get in touch with those already using it and/or taking care of it! This would help facilitate more direct connects between potential users/maintainers. People could just freely get in touch & see how to best to co-operate on keeping the recipe going. How would this work? 1. we need to add a new format to the recipe READMES. e.g. in https://git.coopcloud.tech/coop-cloud/matrix-synapse/src/commit/bca2a983c0668fc6d628c770efc3c61a56f9718d/README.md alongside the *Category*, *Status*, etc. 2. we need to teach `abra` to parse that and add it to the [recipes.json](https://git.coopcloud.tech/coop-cloud/recipes-catalogue-json/src/commit/012dd726363b25489e20f2d3e10a81d21384b97c/recipes.json) 3. we need to get this into the design of the new web UI for the catalogue Proposals for README format? ``` * **Users**: <autonomic helo@autonomic.zone>, <othercoop helo@othercoop.com> * **Maintainers**: <autonomic helo@autonomic.zone> ``` /cc @3wordchant
decentral1se added the
enhancement
abra
labels 2022-04-01 10:45:58 +00:00
decentral1se added this to the Beta release (software) project 2022-04-01 10:46:00 +00:00
decentral1se removed this from the Beta release (software) project 2022-04-01 10:48:06 +00:00
Member

This would be really good to have IMHO

This would be really good to have IMHO
Owner

Yep sounds like a fantastic proposal @decentral1se, no notes

Yep sounds like a fantastic proposal @decentral1se, no notes
Sign in to join this conversation.
No Milestone
No project
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: coop-cloud/organising#307
No description provided.