YunoHost-Apps/documize_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/documize_ynh.git synced 2024-09-03 18:26:19 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2022-06-12 12:28:42 +00:00
parent 44ad9fa1f2
commit 14a901d13e
2 changed files with 36 additions and 85 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
README.md
View file

@ -1,84 +1,54 @@
# Packaging an app, starting from this example
* Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
* Edit the `manifest.json` with app specific info.
* Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
* Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
* Add a `LICENSE` file for the package.
* Edit `doc/DISCLAIMER*.md`
* The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
---
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
# Example app for YunoHost # Documize for YunoHost
[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Working status](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/documize.svg)](https://dash.yunohost.org/appci/app/documize) ![Working status](https://ci-apps.yunohost.org/ci/badges/documize.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/documize.maintain.svg)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Install Documize with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=documize)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Example app quickly and simply on a YunoHost server. > *This package allows you to install Documize quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Overview
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Documize Community is an open source modern, lightweight alternative to Confluence and other similar solutions.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; - Built for technical and non-technical users
- Laboris nisi ut aliquip ex ea commodo consequat ; - Designed to unify both customer-facing and internal documentation
- Duis aute irure dolor in reprehenderit in voluptate ; - Organization through labels, spaces and categories
- Velit esse cillum dolore eu fugiat nulla pariatur ;
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
**Shipped version:** 5.0.1~ynh1
**Shipped version:** 1.0~ynh1
**Demo:** https://demo.example.com **Demo:** https://demo.example.com
## Screenshots ## Screenshots
![Screenshot of Example app](./doc/screenshots/example.jpg) ![Screenshot of Documize](./doc/screenshots/screenshot.png)
## Disclaimers / important information
* 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 ?
## Documentation and resources ## Documentation and resources
* Official app website: <https://example.com> * Official app website: <https://www.documize.com>
* Official user documentation: <https://yunohost.org/apps> * Official admin documentation: <https://docs.documize.com>
* Official admin documentation: <https://yunohost.org/packaging_apps> * Upstream app code repository: <https://github.com/documize/community>
* Upstream app code repository: <https://some.forge.com/example/example> * YunoHost documentation for this app: <https://yunohost.org/app_documize>
* YunoHost documentation for this app: <https://yunohost.org/app_example> * Report a bug: <https://github.com/YunoHost-Apps/documize_ynh/issues>
* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues>
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/documize_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` bash ``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/documize_ynh/tree/testing --debug
or or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade documize -u https://github.com/YunoHost-Apps/documize_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps> **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

55
README_fr.md
View file

@ -3,71 +3,52 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
# Exemple d'app pour YunoHost # Documize pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Niveau d'intégration](https://dash.yunohost.org/integration/documize.svg)](https://dash.yunohost.org/appci/app/documize) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/documize.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/documize.maintain.svg)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Installer Documize avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=documize)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
> *Ce package vous permet d'installer Example app rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d'installer Documize rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## Vue d'ensemble
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Documize Community is an open source modern, lightweight alternative to Confluence and other similar solutions.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; - Built for technical and non-technical users
- Laboris nisi ut aliquip ex ea commodo consequat ; - Designed to unify both customer-facing and internal documentation
- Duis aute irure dolor in reprehenderit in voluptate ; - Organization through labels, spaces and categories
- Velit esse cillum dolore eu fugiat nulla pariatur ;
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
**Version incluse :** 5.0.1~ynh1
**Version incluse :** 1.0~ynh1
**Démo :** https://demo.example.com **Démo :** https://demo.example.com
## Captures d'écran ## Captures d'écran
![Capture d'écran de Example app](./doc/screenshots/example.jpg) ![Capture d'écran de Documize](./doc/screenshots/screenshot.png)
## Avertissements / informations importantes
* 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 ?
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : <https://example.com> * Site officiel de l'app : <https://www.documize.com>
* Documentation officielle utilisateur : <https://yunohost.org/apps> * Documentation officielle de l'admin : <https://docs.documize.com>
* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps> * Dépôt de code officiel de l'app : <https://github.com/documize/community>
* Dépôt de code officiel de l'app : <https://some.forge.com/example/example> * Documentation YunoHost pour cette app : <https://yunohost.org/app_documize>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example> * Signaler un bug : <https://github.com/YunoHost-Apps/documize_ynh/issues>
* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues>
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/documize_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
``` bash ``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/documize_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade documize -u https://github.com/YunoHost-Apps/documize_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps> **Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>