coop-cloud/organising
coop-cloud
/
organising
Archived
4
0
Fork 0
Code Issues 42 Pull Requests Projects Releases Activity

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

New Issue
Closed
opened 2020-10-26 08:02:24 +00:00 by decentral1se · 5 comments
decentral1se commented 2020-10-26 08:02:24 +00:00
Owner
Copy Link

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
3wordchant commented 2020-10-26 09:28:37 +00:00
Owner
Copy Link

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 2020-10-27 08:04:48 +00:00
decentral1se added the
design
 label 2020-10-27 08:09:14 +00:00
decentral1se added this to the (deleted) project 2020-12-27 11:48:46 +00:00
decentral1se removed this from the Public mini-launch milestone 2021-03-02 09:14:57 +00:00
3wordchant commented 2021-03-02 10:53:37 +00:00
Owner
Copy Link

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
🎉 1
decentral1se commented 2021-03-02 10:55:20 +00:00
Author
Owner
Copy Link

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
3wordchant commented 2021-03-02 11:10:44 +00:00
Owner
Copy Link

@decentral1se how's this look?

image

@decentral1se how's this look? ![image](/attachments/1ae6078b-2298-47bb-8b48-e956985311f7)
image.png
21 KiB
❤️ 1
decentral1se added this to the Beta release milestone 2021-03-02 12:20:34 +00:00
3wordchant commented 2021-03-02 18:36:42 +00:00
Owner
Copy Link

All apps updated, declaring this done.

All apps updated, declaring this done.
This repo is archived. You cannot comment on issues.
No Branch/Tag Specified
Branches Tags
master
Labels
Clear labels   
automation

Getting the robots into the mix

  
bug

Something is not working

  
community organising

Opening this thing up

  
democracy

Democratic decision making

  
design

Design thinking required

  
documentation

WTFM

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
finance

Money things

  
funding

Anything related to grant funding

  
help wanted

Need some help

  
invalid

Something is wrong

  
publishing

Making this project public

  
question

More information is needed

  
security

Securing our shit

  
wontfix

This won't be fixed

No Label
automation
bug
community organising
democracy
design
documentation
duplicate
enhancement
finance
funding
help wanted
invalid
publishing
question
security
wontfix
Milestone
Clear milestone
No items
No Milestone
Beta release
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
2 Participants
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#31
No description provided.
Delete Branch "%!s(<nil>)"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?