Conversation
|
I'm all for this 🤩 |
|
Discussed today IRL :
|
alexAubin
force-pushed
the
simpler-readme
branch
from
73e44fb to
4a29b10
Compare
alexAubin
force-pushed
the
simpler-readme
branch
from
4a29b10 to
994b7f9
Compare
|
Merging as discussed in yesterday's meeting |
|
For packagers, having the level of the app and a direct link to Without that, there is no easy way to go from the package to the ci You can see the result at https://github.com/YunoHost-Apps/fab-manager_ynh |
| [](https://ci-apps.yunohost.org/ci/apps/gotosocial/) | ||
|  | ||
|  |
There was a problem hiding this comment.
Let's bring these back?
There was a problem hiding this comment.
I fully agree or just the badge of the level including a link to https://ci-apps.yunohost.org/ci/apps/$app/
There was a problem hiding this comment.
It was removed because as an user the level of the app is almost irrelevant
There was a problem hiding this comment.
We could add a link “to the latest ci test” in the dev part?
There was a problem hiding this comment.
But the git repository is more used by packager than users. Keeping the level of the app and a link to the CI is totally relevant for them
Users go through the webamin of their YunoHost or through the app catalog
There was a problem hiding this comment.
I've made a PR to have the link back to the CI:
#26
The image of the version number of the package don't have a link,, so maybe a good place to insert the link to the CI
There was a problem hiding this comment.
is this an easter egg?
how the fuck am I supposed to guess that clicking on the version goes to the CI?
There was a problem hiding this comment.
is this an easter egg? how the fuck am I supposed to guess that clicking on the version goes to the CI?
nope. not an easter egg, actually the image for the version of the package link to the image itself https://camo.githubusercontent.com, that we don't care. That's why I proposed to go to the CI instead of adding a new image
feel free to propose something else.
There was a problem hiding this comment.
Yet another proposal with:
- bigger app logo
- centered top section
- version text selectable (for easy copy-paste)
- CI badge added
There was a problem hiding this comment.
Maybe CI badge should go in Developper section ?
|
Also having the current version of the package is important for packager. to be able to have it in the readme seems to me important instead of going in the manifest.toml |
But has it been removed ? apps_tools/readme_generator/README.md.j2 Line 32 in 994b7f9 |
well, now it's an image, less easier to copy/paste |
|
The upstream code link has been removed? I use it very frequently. Can it be as an icon (github, gitlab, others) |
|
|
No it's there apps_tools/readme_generator/README.md.j2 Line 41 in 994b7f9 |
|
(CI level / badge re-added in developer section in 6d3bd64 ) |
8 participants
The current system is flooding every app PR with boring README diffs because it updates every translations ... in the meantime, the README itself feels bloated with badges and stuff like
This package allows you to install $app quickly and simply on a YunoHost server.etc ...Ultimately imho Github READMEs can't be the place where we can have a proper presentation of the app, both because it's limited in terms of i18n and styling capabilities (it's just markdown with very few HTML/CSS features available), and because we can't expect random folks to be comfortable browsing Github repositories which are more of a power-user thing.
So here's the proposal to drop i18n for the READMEs and have a kind minimalistic README instead with only the short description, encourage people to browse the app catalog instead, and dev infos. Example for Nextcloud (i still need to update the badges tho):