Pick a README.md template for app repositories for consistency #31

Closed
opened 2 years ago by decentral1se · 5 comments
Owner

Like YunoHost app repositories, when you see the README, it gives you a run down of what is going on. We could skip this and instead just put documentation for apps on https://docs.cloud.autonomic.zone but either way, we should settle on a README template for consistency even if it is 2 lines, I guess. I don't want to make much more work for ourselves but it would be good to have something for this. For reference: https://github.com/YunoHost-Apps/nextcloud_ynh

Like YunoHost app repositories, when you see the README, it gives you a run down of what is going on. We could skip this and instead just put documentation for apps on https://docs.cloud.autonomic.zone but either way, we should settle on a README template for consistency even if it is 2 lines, I guess. I don't want to make much more work for ourselves but it would be good to have something for this. For reference: https://github.com/YunoHost-Apps/nextcloud_ynh
Owner

Agreed! I had made a start here: https://git.autonomic.zone/coop-cloud/example

Possible additions:

  • Upstream image (name + link)
  • Link to Coop Cloud docs
Agreed! I had made a start here: https://git.autonomic.zone/coop-cloud/example Possible additions: - Upstream image (name + link) - Link to Coop Cloud docs
decentral1se added this to the Public mini-launch milestone 2 years ago
decentral1se added the
design
label 2 years ago
decentral1se added this to the (deleted) project 2 years ago
decentral1se removed this from the Public mini-launch milestone 1 year ago
Owner

I'd like to get this done so that we can compile the app catalogue automagically based on the READMEs. I think that means that READMEs should contain:

  • App name
  • Category (apps / dev / util / ☠)
  • Link to upstream repo
  • Overall status score
  • Link to upstream image
  • Image score
  • Healthcheck Y/N
  • Backups score
  • Email score
  • CI score
I'd like to get this done so that we can compile the [app catalogue](https://cloud.autonomic.zone/apps/) automagically based on the READMEs. I think that means that READMEs should contain: - App name - Category (apps / dev / util / ☠) - Link to upstream repo - Overall status score - Link to upstream image - Image score - Healthcheck Y/N - Backups score - Email score - CI score
Poster
Owner

I'd like to get this done so that we can compile the app catalogue automagically based on the READMEs.

🤯

Go go go go go go go

> I'd like to get this done so that we can compile the app catalogue automagically based on the READMEs. 🤯 Go go go go go go go
Owner

@decentral1se how's this look?

image

@decentral1se how's this look? ![image](/attachments/1ae6078b-2298-47bb-8b48-e956985311f7)
decentral1se added this to the (deleted) milestone 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
3wordchant referenced this issue from a commit 1 year ago
Owner

All apps updated, declaring this done.

All apps updated, declaring this done.
3wordchant closed this issue 1 year ago
Sign in to join this conversation.
Loading…
There is no content yet.