plex_fr_discord_repo/README.md
2021-02-25 23:32:38 +01:00

70 lines
2.2 KiB
Markdown

# Repo Officiel du Discord Plex FR
Retrouvez-nous ici : https://discord.gg/ERpYMqS
![](https://i.imgur.com/RiGJ5pK.png)
## Table des matières
* [Comment utiliser Git](#wiki)
* [docker-compose](#docker-compose)
* [wiki](#wiki)
## Comment utiliser Git
Clonez le dépot sur votre machine `git clone https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo.git`
### Pour chaque modification, attention à bien suivre cette procédure si vous voulez éviter des conflits de versions
- Créez votre branche via la GUI Gitea (idéalement votre pseudo) ex : Benj
- Rapatriez les dernières modifications : `git pull`
- Faites vos modificatiosn (création de fichiers etc)
- Ajoutez les nouveaux fichiers : `git add .`
- Validez les modif : `git commit -m "ma super modif"`
- Balancez sur le serveur : `git push`
- Et ouvrez une pull request via la GUI
## docker-compose
### fonctionnement
Le répertoire `docker-compose/` contient uniquement les docker-compose de chaque service/application.
L'arborescence doit être la suivante :
`docker-compose/<app>/docker-compose.yml`
- `<app>` : le nom de l'application ou service à rajouter
### Possibilité
Le bot pourrait appeler le contenu de chaque application selon cette commande
`.docker-compose <app>`
Il chercherait selon l'url suivant :
`https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/master/docker-compose/<app>/docker-compose.yml`
Si HTTP 200 alors on affiche le contenu retourné
Sinon HTTP 404 alors on affiche `la page n'existe pas`
Exemple ok:
> `.docker-compose plex`
> renvoie le contenu de
> https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/master/docker-compose/plex/docker-compose.yml
Exemple ko:
> `.docker-compose pouet`
> renvoie `La page que vous demandez n'existe pas`
**ZZ_Exemple sera supprimé à terme**
## wiki
fichiers au format md (markdown)
### Possibilité
Le bot pourrait appeler le contenu de chaque application selon cette commande
`.wiki <doc>`
Il chercherait selon l'url suivant :
`https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/master/wiki/<doc>.md`
Si HTTP 200 alors on affiche le contenu retourné
Sinon HTTP 404 alors on affiche `la page n'existe pas`