doc: proposed structure for documentation => one place to see them all. Add in doc/readme.md all the source for documentation include emissary-agent
All checks were successful
arcad/emissary/pipeline/head This commit looks good

This commit is contained in:
lseys 2023-08-25 13:29:29 +02:00
parent 5c36955c13
commit a1ec5b87c8
3 changed files with 83 additions and 0 deletions

View File

@ -16,6 +16,10 @@ Download the pre-compiled binaries from the [releases page](https://forge.cadole
See [`doc`](./doc/README.md)
## Avancée
See [TODO](./doc/fr/TODO.md)
## Licence & mentions
[AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html#license-text)

View File

@ -12,6 +12,31 @@ Emplacement des différentes documentation pour installation emissary.
- (FR) -[Différentes méthodes pour installer emissary](./tutorials/fr/install-emmissary-only.md)
## Emissary-agent
### borne
- [banana-bpi](https://forge.cadoles.com/arcad/emissary-firmware/src/branch/bananapi-r3/doc/Hardware-Sheet/banana-rpi-sheet.md)
- raspberry (a venir)
- linksys (a venir)
### BUILD
- [Compiler un firmware](https://forge.cadoles.com/arcad/emissary-firmware/src/branch/master/doc/tutorials/firmware-compilation.md)
- Compiler un firmware préconfiguré
- Créer une nouvelle cible de construction
- [flasher une borne](https://forge.cadoles.com/arcad/emissary-firmware/src/branch/bananapi-r3/doc/tutorials/device-flashing.md)
## DEBUG
### emissary-server
> TODO
### emissary-agent
> TODO
## References
### Specifications

54
doc/fr/TODO.md Normal file
View File

@ -0,0 +1,54 @@
# document de suivi des évolutions et test
## tableau de suivi
| etat | action | détail |
| :- | :-: | :- |
| OK | construction d'un firmware (bpi-r3) | #valide2023-08-02 |
| OK | documentation construction d'un firmware pour les autres version | #valide2023-08-02 |
| OK | installation d'un firmware sur bananapi bpi-r3 | #valide2023-08-16 |
| OK | validation firmware pour bananapi bpi-r3 | #valide2023-08-18 |
| OK | test appairage banana pi bpi-r3 | #valide2023-08 |
| OK | validation firmware pour bananapi bpi-r3 | #valide |
| EnCours | pousser dans la branche master construction d'un firmware (bpi-r3) | - |
| EnCours | installation d'un firmware sur raspberry3 | - |
| EnCours | validation firmware pour raspberry3 | fonctionnement avant apparaige |
| NEXT | test appairage raspberry3 | implique réalisation d'une doc |
| NEXT | validation firmware pour raspberry3 | fonctionnement après apparaige |
| NEXT | test appairage pour raspberry3 | fonctionnement après apparaige |
| NEXT | validation/réalisation documentation | - |
| NOK | construction d'un firmware sur lynksys | - |
| NOK | installation d'un firmware sur lynksys | - |
| NOK | - | - |
| NOK | - | - |
| NOK | chaîne de validation avant/après apparairage | implique réalisation d'une doc |
| Server| SERVER | server |
| OK | installation emissary server en locale | via tar.gz #valide2023-08-02 |
| OK | validation installation du server en locale | #valide2023-08 |
| OK | installation emissary server sur ubuntu mint 21.0 | via paquet .deb #valide2023-08-02 |
| OK | installation emissary server sur ubuntu 22.04 | via paquet .deb #valide2023-08-02 |
| OK | validation installation du server | #valide2023-08 |
| OK | appairage borne (bpi-r3) sur emissary-server (ubuntu) | #valide2023-08 |
| OK | appairage documentation (ubuntu) borne (bpi-r3) | #valide2023-08 |
| OK | validation ansible | #valide2023-08 alpine3.16 |
| OK | validation ansible | #valide2023-08 alpine3.18 |
| OK | validation ansible documentation | #valide2023-08 |
| OK | appairage borne (bpi-r3) sur emissary-server (alpine 3.16 & 3.18) | #valide2023-08 |
| OK | appairage documentation (ansible alpine) borne (bpi-r3) | #valide2023-08 |
| OK | modification conf uci d'une borne | #valide2023-08 |
| OK | documentation modification conf uci d'une borne | #valide2023-08 |
| autre | AUTRE | autre |
| EnCours | relecture doc officiel | implique application des actions mentionné |
| EnCours | création d'un point de redirection pour toute la documentation | |
## demande supplémentaire
Stipuler l'émetteur permet de savoir à qui s'adresser pour en discuter.
| STATUS | action | détail | emetteur|
|:- | :-: | :- | :- |
installation/debug emissary-server | lseys |
| Proposition | CODE | script de validation installation/debug emissary-agent | lseys |
| Proposition | CODE | script de validation
| Proposition | DOC | debug/astuce emissary-server | lseys |
| Proposition | DOC | debug/astuce emissary-agent | lseys |