mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
Merge branch 'grav' of https://github.com/YunoHost/doc
This commit is contained in:
Yunohost-Bot
commit
42a3f703a9
19 changed files with 38 additions and 161 deletions
|
|
@ -7,6 +7,8 @@ routes:
|
|||
default: '/docs'
|
||||
---
|
||||
|
||||
! This page is obsolete and should be reworked
|
||||
|
||||
La documentation de YunoHost s’articule autour de deux sections :
|
||||
|
||||
[[fa=fa-lock /] Guide de l’administrateur](/administrate?classes=btn,btn-lg,btn-primary)
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ routes:
|
|||
default: '/docs'
|
||||
---
|
||||
|
||||
! This page is obsolete and should be reworked
|
||||
|
||||
YunoHost's documentation has 2 different sections:
|
||||
|
||||
[[fa=fa-lock /] Administrator's guide](/administrate?classes=btn,btn-lg,btn-primary)
|
||||
|
|
|
|||
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
title: Diagnostic du bon fonctionnement de YunoHost
|
||||
template: docs
|
||||
taxonomy:
|
||||
category: docs
|
||||
routes:
|
||||
default: '/diagnostic'
|
||||
---
|
||||
|
||||
Pour vérifier que tous les aspects critiques de votre serveur sont correctement
|
||||
configurés, il est recommandé d'utiliser le système de diagnostic disponible
|
||||
dans la webadmin de YunoHost. (Cette fonctionnalité a été ajoutée dans la version
|
||||
3.8)
|
||||
|
||||
Quelques points à retenir:
|
||||
* Le diagnostique tourne périodiquement
|
||||
* Un email est envoyé à root, qui est normalement forwardé vers le premier utilisateur créé
|
||||
* Les problèmes trouvés doivent soient être réglé, soit ignorés (si ils sont
|
||||
compris ou ne sont pas pertinents) autrement un mail est envoyé deux fois par
|
||||
jour.
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
---
|
||||
title: Diagnose YunoHost functioning
|
||||
template: docs
|
||||
taxonomy:
|
||||
category: docs
|
||||
routes:
|
||||
default: '/diagnostic'
|
||||
---
|
||||
|
||||
To diagnose that all critical aspects of your server are properly configured,
|
||||
you should run a diagnosis from the webadmin in the "Diagnosis" section. (This
|
||||
feature was added in YunoHost 3.8).
|
||||
|
||||
TODO: elaborate on the fact that the diagnosis runs periodically, sends an email
|
||||
to root which is forwarded to the very first user created, and that issues
|
||||
should either be fixed or ignored (if they are understood/not relevant)
|
||||
otherwise an email will be sent twice a day..
|
||||
|
|
@ -7,7 +7,10 @@ routes:
|
|||
default: '/yunohost_project_organization'
|
||||
---
|
||||
|
||||
! This page is outdated and should be reworked
|
||||
|
||||
## Objectif du document
|
||||
|
||||
Ce document a pour objectif de permettre aux contributeurs de se sentir légitimes d’effectuer une contribution dans le projet YunoHost avec un avis collectif. Il vise également à renforcer le projet en le structurant autour de groupes de travail autonomes pouvant résister au départ ou à l'absence de certains contributeurs.
|
||||
Le projet étant communautaire, les décisions prises hâtivement et discrètement par un groupe restreint de contributeurs peuvent entraîner des frustrations postérieures.
|
||||
Pour pallier ce problème, la solution proposée ici est de faire en sorte que les décisions soient prises collectivement, qu’elles soient suffisamment réfléchies, et qu'elles soient documentées ou rendues publiques.
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ routes:
|
|||
default: '/yunohost_project_organization'
|
||||
---
|
||||
|
||||
! This page is outdated and should be reworked
|
||||
|
||||
## Document objective
|
||||
|
||||
This document aims at allowing contributors to feel legitimate in contributing to the YunoHost project together with collective feedback.
|
||||
|
|
|
|||
|
|
@ -5,20 +5,10 @@ taxonomy:
|
|||
category: docs
|
||||
routes:
|
||||
default: '/use_case_non-profit_organisations'
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
## Taula de continguts
|
||||
* [Introducció](#introduction)
|
||||
* [Qui](#who)
|
||||
* [Què](#what)
|
||||
* [Quan](#when)
|
||||
* [On](#where)
|
||||
* [Per què](#why)
|
||||
* [Com](#how)
|
||||
* [Conclusió](#conclusion)
|
||||
|
||||
## Introducció
|
||||
|
||||
L'objectiu d'aquest document és presentar un cas d'ús específic de [YunoHost](https://yunohost.org) per a organitzacions sense ànim de lucre.
|
||||
|
||||
## Qui
|
||||
|
|
|
|||
|
|
@ -5,20 +5,10 @@ taxonomy:
|
|||
category: docs
|
||||
routes:
|
||||
default: '/use_case_non-profit_organisations'
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
## Table des matières
|
||||
* [Introduction](#introduction)
|
||||
* [Qui ](#qui)
|
||||
* [Quoi](#quoi)
|
||||
* [Quand](#quand)
|
||||
* [Où](#o-)
|
||||
* [Pourquoi](#pourquoi)
|
||||
* [Comment](#comment)
|
||||
* [Conclusion](#conclusion)
|
||||
|
||||
## Introduction
|
||||
|
||||
L'objet de ce document est de présenter une utilisation spécifique de [YunoHost](https://yunohost.org/) pour des organisations à but non lucratif.
|
||||
|
||||
## Qui
|
||||
|
|
|
|||
|
|
@ -5,21 +5,11 @@ taxonomy:
|
|||
category: docs
|
||||
routes:
|
||||
default: '/use_case_non-profit_organisations'
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
* [Introduction](#introduction)
|
||||
* [Who](#who)
|
||||
* [What](#what)
|
||||
* [When](#when)
|
||||
* [Where](#where)
|
||||
* [Why](#why)
|
||||
* [How](#how)
|
||||
* [Conclusion](#conclusion)
|
||||
|
||||
## Introduction
|
||||
|
||||
The object of this document is to present a specific use of [YunoHost](https://yunohost.org/) for non-profit organizations.
|
||||
The purpose of this document is to present a specific use of [YunoHost](https://yunohost.org/) for non-profit organizations.
|
||||
|
||||
## Who
|
||||
|
||||
|
|
|
|||
|
|
@ -5,20 +5,10 @@ taxonomy:
|
|||
category: docs
|
||||
routes:
|
||||
default: '/use_case_non-profit_organisations'
|
||||
page-toc:
|
||||
active: true
|
||||
---
|
||||
|
||||
## Ensenhador
|
||||
* [Introduccion](#introduccion)
|
||||
* [Qual ](#qual)
|
||||
* [Qué](#qué)
|
||||
* [Quand](#quand)
|
||||
* [Ont](#ont)
|
||||
* [Perque](#perque)
|
||||
* [Cossí](#cossí)
|
||||
* [Conclusion](#conclusion)
|
||||
|
||||
## Introduccion
|
||||
|
||||
L'objectiu d’aqueste document es de presentar una utilizacion especifica de [YunoHost](https://yunohost.org/) per d’organizacions sens tòca lucrativa.
|
||||
|
||||
## Qual
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ routes:
|
|||
default: '/write_documentation'
|
||||
---
|
||||
|
||||
! This page is outdated and should be reworked
|
||||
|
||||
## Sur le site
|
||||
|
||||
Ce site permet d’éditer le contenu directement en ligne.
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ routes:
|
|||
default: '/write_documentation'
|
||||
---
|
||||
|
||||
! This page is outdated and should be reworked
|
||||
|
||||
## Online
|
||||
|
||||
This site allows to edit content directly online.
|
||||
|
|
|
|||
|
|
@ -11,6 +11,8 @@ routes:
|
|||
|
||||
Ce document a pour but de vous apprendre à packager une application pour YunoHost.
|
||||
|
||||
! This page is outdated and should be reworked
|
||||
|
||||
### Prérequis
|
||||
Pour packager une application, voici les prérequis :
|
||||
* Un compte sur un serveur Git comme [GitHub](https://github.com/) pour pouvoir ensuite publier l’application ;
|
||||
|
|
@ -54,36 +56,6 @@ Comme les instances de YunoHost possèdent une architecture unifiée, vous serez
|
|||
### Commandes pratiques
|
||||
[div class="btn btn-lg btn-default"] [Commandes pratiques](/packaging_apps_helpers) [/div]
|
||||
|
||||
### Référencement des logs
|
||||
Dans de nombreuses situations, vous pouvez vouloir indexer un fichier de log pour qu'il soit affiché dans la webadmin. Pour indexer un log, il faut créer un fichier d'indexation dans `/var/log/yunohost/categories/app/APPNAME.yml`.
|
||||
|
||||
Il est possible de spécifier la date de début en commençant le nom de fichier par la date `YYYYMMDD-HHMMSS`.
|
||||
|
||||
Exemple de fichier de log d'indexation :
|
||||
```bash
|
||||
log_path: /chemin/vers/le/fichier.log
|
||||
```
|
||||
|
||||
Il est possible d'afficher des infos complémentaires, la variable env sera affichée dans la partie "Contexte" :
|
||||
```bash
|
||||
extra:
|
||||
env:
|
||||
args1: value1
|
||||
args2: value2
|
||||
args3: value3
|
||||
```
|
||||
|
||||
Il est possible de rattacher le log à une application précise et/ou un service, un nom de domaine, une personne :
|
||||
```bash
|
||||
related_to:
|
||||
- ['app', 'APPNAME']
|
||||
- ['service', 'SERVICE1']
|
||||
- ['service', 'SERVICE2']
|
||||
- ['domain', 'DOMAIN.TLD']
|
||||
```
|
||||
|
||||
Ces informations seront utilisées pour permettre de filtrer les logs en relation avec une de ces entités application, service, domaine, personne.
|
||||
|
||||
|
||||
### Améliorer la qualité du paquet d’installation
|
||||
Vous trouverez ci-dessous une liste des points à vérifier concernant la qualité de vos scripts :
|
||||
|
|
|
|||
|
|
@ -11,6 +11,8 @@ routes:
|
|||
|
||||
The purpose of this document is to teach you how to package an application for YunoHost.
|
||||
|
||||
! This page is outdated and should be reworked
|
||||
|
||||
### Requirements
|
||||
To package an application, here are the requirements:
|
||||
* An account on a Git server (e.g. [GitHub](https://github.com/)) to publish the application;
|
||||
|
|
@ -57,37 +59,6 @@ Take a look at the [Nextcloud package](https://github.com/YunoHost-Apps/nextclou
|
|||
### Helpers
|
||||
[div class="btn btn-lg btn-default"] [Helpers](/packaging_apps_helpers) [/div]
|
||||
|
||||
### Registering a log file
|
||||
|
||||
In a lot of case, you might want to register a log file created by your app, to make it available in the webadmin. To register a log, you can create a reference file `/var/log/yunohost/categories/app/APPNAME.yml`.
|
||||
|
||||
You can specify a start date by starting the file name with the date formatted as `YYYYMMDD-HHMMSS`.
|
||||
|
||||
Example of yml metadata log file:
|
||||
```bash
|
||||
log_path: /path/to/your/log/file.log
|
||||
```
|
||||
|
||||
If you want display some context info, you can add:
|
||||
```bash
|
||||
extra:
|
||||
env:
|
||||
args1: value1
|
||||
args2: value2
|
||||
args3: value3
|
||||
```
|
||||
|
||||
You can attach the log to an app, domain, service or user like this :
|
||||
```bash
|
||||
related_to:
|
||||
- ['app', 'APPNAME']
|
||||
- ['service', 'SERVICE1']
|
||||
- ['service', 'SERVICE2']
|
||||
- ['domain', 'DOMAIN.TLD']
|
||||
```
|
||||
|
||||
This will be used to filter logs and display all log related to an entity like a user, a domain, an app or a service.
|
||||
|
||||
### Test it!
|
||||
In order to test your package, you can execute your script standalone as `admin` (do not forget to append required arguments):
|
||||
```bash
|
||||
|
|
|
|||
|
|
@ -7,16 +7,11 @@ routes:
|
|||
default: '/packaging_apps_guidelines'
|
||||
---
|
||||
|
||||
<div class="alert alert-danger">
|
||||
<b>
|
||||
Cette page est en cours d'élaboration. Tant que cet avertissement n'est pas enlevé. Considérez ces informations comme potentiellement fausse.
|
||||
Le nom YEP n'est à priori pas définitif, ni les niveaux, ni les bonnes pratiques en elle-même.
|
||||
</b>
|
||||
</div>
|
||||
|
||||
### Introduction
|
||||
Ce document a pour but de lister les différentes bonnes pratiques concernant la création de paquet d'application YunoHost.
|
||||
|
||||
!!! This page is outdated and should be reworked
|
||||
|
||||
Chaque bonne pratique est numérotée avec un numéro suffixé par les lettres YEP (YunoHost Enhancement Proposals), ceci afin de pouvoir y faire référence facilement dans les outils d'analyse automatique de paquet ([package checker](https://github.com/YunoHost/package_check), [package linter](https://github.com/YunoHost/package_linter)), mais également lors des revues de code.
|
||||
|
||||
Chaque YEP est associée à :
|
||||
|
|
|
|||
|
|
@ -7,16 +7,11 @@ routes:
|
|||
default: '/packaging_apps_guidelines'
|
||||
---
|
||||
|
||||
<div class="alert alert-danger">
|
||||
<b>
|
||||
This page is under development. As long as this warning is not removed. Consider this information as potentially false.
|
||||
The name YEP is not a priori definitive, neither the levels nor the good practices in itself.
|
||||
</b>
|
||||
</div>
|
||||
|
||||
### Introduction
|
||||
The purpose of this document is to list the various best practices concerning the creation of YunoHost application packages.
|
||||
|
||||
!!! This page is outdated and should be reworked
|
||||
|
||||
Each good practice is numbered with a number suffixed by the letters YEP (YunoHost Enhancement Proposals), so that it can be easily referenced in the ([package checker](https://github.com/YunoHost/package_check) and [package linter](https://github.com/YunoHost/package_linter)) tools, but also during the reviews of code.
|
||||
|
||||
Each YEP is associated with:
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ routes:
|
|||
default: '/packaging_apps_ci'
|
||||
---
|
||||
|
||||
! This page is outdated and should be reworked
|
||||
|
||||
Un serveur d'intégration continue est disponible pour tout packager souhaitant tester une application avec [Package_check](https://github.com/YunoHost/package_check).
|
||||
|
||||
[ci-apps-dev](https://ci-apps-dev.yunohost.org?classes=btn,btn-lg,btn-primary)
|
||||
|
|
|
|||
|
|
@ -7,6 +7,8 @@ routes:
|
|||
default: '/packaging_apps_ci'
|
||||
---
|
||||
|
||||
! This page is outdated and should be reworked
|
||||
|
||||
A continuous integration server is available for any packager willing to test an app with [Package_check](https://github.com/YunoHost/package_check).
|
||||
|
||||
[ci-apps-dev](https://ci-apps-dev.yunohost.org?classes=btn,btn-lg,btn-primary)
|
||||
|
|
|
|||
|
|
@ -227,6 +227,10 @@ body .off-canvas .learn-sidebar .searchbox input {
|
|||
color: rgb(78, 78, 78);
|
||||
}
|
||||
|
||||
body #top-bar #breadcrumbs > span, body #top-bar .progress {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/*
|
||||
###############################################################################
|
||||
Style sheet for the cards
|
||||
|
|
|
|||
Loading…
Reference in a new issue