Utiliser plus souvent des formulaires de substitution dans les sujets de documentation ?

M’a fait penser que meta est, en partie, une plateforme de documentation.

La recherche de example.discourse.com dans la documentation renvoie 46 résultats (et d’autres sujets peuvent utiliser un autre domaine).

Ces sujets pourraient bénéficier des formulaires de substitution (placeholders). Exemple unique d’un sujet avec de nombreuses mentions de discourse.example.com : Discourse Doc Categories

Que diriez-vous d’utiliser placeholder-forms sur ces sujets ?

4 « J'aime »

Je suis entièrement d’accord avec @Canapin ! Je suis un grand fan du composant placeholder-forms et je l’utilise sur tous mes Discourses personnels et professionnels, pour la documentation, la création de Runbooks et pour semi-automatiser des processus qui ne sont pas prêts pour un script Bash.

Voici un exemple qui utilise un Placeholder Publishing a Material for MkDocs site to Azure, with automatic branch/PR preview deployments - blog - Baw Medical Ltd

J’aimerais voir des articles dans Documentation > Self-Hosting et Community wiki > Sysadmins utiliser des placeholders partout où il y a du texte/commande à utiliser qui nécessite une personnalisation en temps réel avec l’entrée de l’utilisateur.

3 « J'aime »

J’aime aussi le composant de substitution (placeholder). Use a subfolder (path prefix) to serve Discourse with multiple servers sharing a domain est un exemple où il est déjà utilisé, et le composant de substitution fonctionne également dans la traduction automatique (au moins en allemand ; j’avais un peu peur que l’IA ne casse le formatage).

J’aimerais aussi voir l’ icône Discourse utilisée plus souvent au lieu de minuscules captures d’écran d’une icône ou de l’utilisation d’un emoji qui lui ressemble.

2 « J'aime »