Annexes
Édition de la documentation
Nuxt Studio permet aux utilisateurs autorisés de modifier la documentation depuis une interface web, sans installer l'environnement de développement.
Édition de la documentation
Nuxt Studio permet aux utilisateurs autorisés de modifier la documentation depuis une interface web, sans installer l'environnement de développement.
Accès avec basic auth
| Étape | Action |
|---|---|
| Ouvrir Studio | Aller sur /_studio |
| S'authentifier | Saisir l'identifiant et le mot de passe basic auth |
| Modifier | Éditer les pages Markdown depuis l'interface visuelle |
| Publier | Envoyer les changements vers GitHub |
| Déployer | L'hébergement reconstruit la documentation depuis le commit |
Règles d'autorisation
- L'accès à Studio est réservé aux personnes qui possèdent l'identifiant et le mot de passe basic auth.
- Les modifications sont publiées dans le dépôt GitHub configuré.
- Le token GitHub doit avoir le droit de lecture/écriture sur le contenu du dépôt.
- Les commits créés depuis Studio utilisent le préfixe
docs:. - Les secrets basic auth et GitHub restent dans les variables d'environnement, pas dans le code.
- L'identité Studio affichée peut être configurée avec
TARS_DOCS_STUDIO_USER_NAMEetTARS_DOCS_STUDIO_USER_EMAIL.
Points d'attention
- Le déploiement avec Studio doit utiliser
nuxt build, pas uniquementnuxt generate, car Studio a besoin de routes serveur. - Les pages peuvent rester prérendérisées pour la performance.
- La basic auth protège aussi les routes Studio.
- Tous les utilisateurs basic auth partagent la même identité Studio; ce mode est adapté à une première étape simple, pas à un audit individuel fin.
- Les changements publiés par le métier doivent passer par le même cycle de build et de vérification que les autres changements de documentation.