init: add documantation

Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>
This commit is contained in:
GnomeZworc 2025-10-27 13:35:47 +01:00
commit 9e98700eb8
Signed by: nicolas.boufideline
GPG key ID: 4406BBBF8845D632
4 changed files with 36 additions and 0 deletions

8
docs/README.md Normal file
View file

@ -0,0 +1,8 @@
# Documentation
[Names](https://www.monde-animal.fr/liste-animaux-a-z/)
- [how to dev](./dev.md)
- [how to release](./release.md)
# Release list

1
docs/dev.md Normal file
View file

@ -0,0 +1 @@
# Developpement environement

12
docs/release.md Normal file
View file

@ -0,0 +1,12 @@
# How to release
```
curl https://git.g3e.fr/H6N/tools/raw/branch/main/scripts/release.sh | bash -s - -t [Version] -n [Name] -c
update all necessary file :
- ./docs/release/next_release.md
- ./docs/README.md
- ./.env
curl https://git.g3e.fr/H6N/tools/raw/branch/main/scripts/release.sh | bash -s -
```

15
docs/release/.template.md Normal file
View file

@ -0,0 +1,15 @@
# NAME VERSION
## Upgrade Procedure
```
git fetch --all
git checkout VERSION
docker compose pull
docker compose up -d
```
## Release feature
- ...
- ...