Merge pull request #155 from YunoHost/standardize-upstream-info-and-readme
Standardize upstream info, disclaimers, screenshots
This commit is contained in:
commit
cf747557cf
5 changed files with 23 additions and 4 deletions
0
doc/.gitkeep
Normal file
0
doc/.gitkeep
Normal file
12
doc/DISCLAIMER.md
Normal file
12
doc/DISCLAIMER.md
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||||
|
* requiring a full dedicated domain ?
|
||||||
|
* architectures not supported ?
|
||||||
|
* not-working single-sign on or LDAP integration ?
|
||||||
|
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||||
|
* etc...
|
||||||
|
|
||||||
|
* Other infos that people should be aware of, such as:
|
||||||
|
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||||
|
* how to configure / administrate the application if it ain't obvious
|
||||||
|
* upgrade process / specificities / things to be aware of ?
|
||||||
|
* security considerations ?
|
0
doc/screenshots/.gitkeep
Normal file
0
doc/screenshots/.gitkeep
Normal file
BIN
doc/screenshots/example.jpg
Normal file
BIN
doc/screenshots/example.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 35 KiB |
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "YunoHost example app",
|
"name": "Example app",
|
||||||
"id": "ynhexample",
|
"id": "example",
|
||||||
"packaging_format": 1,
|
"packaging_format": 1,
|
||||||
"description": {
|
"description": {
|
||||||
"en": "Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)",
|
"en": "Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)",
|
||||||
|
@ -8,11 +8,18 @@
|
||||||
},
|
},
|
||||||
"version": "1.0~ynh1",
|
"version": "1.0~ynh1",
|
||||||
"url": "https://example.com",
|
"url": "https://example.com",
|
||||||
|
"upstream": {
|
||||||
|
"license": "free",
|
||||||
|
"website": "https://example.com",
|
||||||
|
"demo": "https://demo.example.com",
|
||||||
|
"admindoc": "https://yunohost.org/packaging_apps",
|
||||||
|
"userdoc": "https://yunohost.org/apps",
|
||||||
|
"code": "https://some.forge.com/example/example"
|
||||||
|
},
|
||||||
"license": "free",
|
"license": "free",
|
||||||
"maintainer": {
|
"maintainer": {
|
||||||
"name": "John doe",
|
"name": "John doe",
|
||||||
"email": "john.doe@example.com",
|
"email": "john.doe@example.com"
|
||||||
"url": "http://example.com"
|
|
||||||
},
|
},
|
||||||
"requirements": {
|
"requirements": {
|
||||||
"yunohost": ">= 4.1.3"
|
"yunohost": ">= 4.1.3"
|
||||||
|
|
Loading…
Reference in a new issue