Puis-je utiliser un lien externe ici ? Et utiliser _blank pour ouvrir un nouvel onglet ?
Vous pouvez commencer par une brève description facultative de la catégorie.
## Test externe
* Google : https://google.com
## Première section
* https://discourse.example.com/t/topic-title/12
* https://discourse.example.com/t/another-topic-title/34
* Titre court : https://discourse.example.com/t/topic-with-a-long-title/56
* Autre titre : https://discourse.example.com/t/another-topic-with-a-long-title/78
## Deuxième section
* Titre du sujet : https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76
Toute installation non prise en charge recevra généralement un lien vers les installations non prises en charge. Comme avertissement, tout problème pourrait être en partie lié.
Les plugins, thèmes et composants de thèmes auront généralement un fichier concernant la compatibilité des versions.
L’ouverture de ce fichier donnera des notes importantes sur la compatibilité des versions. D’autres peuvent l’avoir dans la description. Par exemple, le plugin Category Moderators améliore le plugin et indique qu’il ne prend en charge que la branche stable.
Pavilion donne la fréquence de mise à jour recommandée de Discourse pour s’assurer qu’ils ont le temps de mettre à jour leurs modules complémentaires.
Est-ce que cela fonctionne pour les sous-catégories ? J’ai un site avec 6 catégories principales mais je veux de la documentation pour chaque catégorie, ainsi que des discussions. Je ne suis pas tout à fait sûr de la meilleure façon d’y parvenir.
Je viens de tomber sur ceci et j’ai quelques questions s’il vous plaît : Comment pouvons-nous l’installer sur notre site hébergé dans le cloud ? Et combien de temps les anciens Docs seront-ils encore disponibles, selon vous ?
Nous n’avons pas encore de calendrier pour la suppression complète de l’ancien plugin, mais il n’est plus activement développé. Une fois que nous aurons pris des décisions à ce sujet, nous publierons une annonce pour en informer tout le monde !
Étant donné que ce plugin est toujours #expérimental, il n’est pas disponible sur notre hébergement, mais nous en discutons actuellement en interne et voyons si nous pouvons rendre ce plugin disponible. Nous reviendrons ici une fois que nous serons arrivés à une conclusion.
Je vais juste ajouter ceci pour les autres qui pourraient trouver cela déroutant, comme je l’étais, ce que le plugin fait réellement.
Avec tous les paramètres, le sujet d’index, etc., cela peut sembler écrasant, en plus d’essayer de comprendre ce qui peut être fait, comment cela peut être utilisé, etc. Du moins, j’étais un peu confus jusqu’à ce que je trouve un moyen de le comprendre (si je manque quelque chose ici, n’hésitez pas à le partager).
Donc, en gros, la façon dont je le vois, c’est : créez vos catégories comme vous le souhaitez, puis ce plugin supprime simplement la barre latérale par défaut (avec les sections pour les catégories, les tags, etc.) et la remplace par une liste de sections et de liens à l’intérieur de ces sections vers des sujets, des catégories, des liens externes, etc. C’est juste plus facile pour moi de le voir de cette façon. C’est quelque chose de plus axé sur la personnalisation de la barre latérale lorsqu’une catégorie particulière est visitée. Quelque chose comme : lorsque la catégorie A est visitée, remplacez la barre latérale par défaut par cette barre latérale personnalisée fournie par le sujet d’index. Simple.
Je me demande comment rendre l’index de la barre latérale sur Docs plus visible sur mobile, car les utilisateurs ne voient pas les sujets jusqu’à ce qu’ils appuient sur l’icône hamburger.
C’est merveilleux sur desktop ; malheureusement, la majorité utilise leur smartphone.
Il n’y a pas beaucoup d’options, ou je dirais qu’il n’y en a aucune. Les mobiles n’ont tout simplement pas assez d’espace.
C’est une des raisons pour lesquelles j’envisage de quitter totalement les docs. Environ 95% de mes utilisateurs utilisent des mobiles, et ils utilisent la barre latérale très rarement, voire pas du tout. Donc, la curation du menu de documentation prend beaucoup de temps et je ne pense pas que le ratio temps/bénéfice soit équilibré
Bien, j’ai lu toute cette discussion et j’ai quelques questions. Je comprends que la structure de cette page est créée par cette page, mais alors vous avez aussi besoin d’une page d’index pour chaque sous-catégorie ? L’index pour cette page, doit être énorme… ou l’une des autres avec une tonne d’articles.
Serait-il difficile d’implémenter une mise en page de style xwiki pour les pages qui font partie de la documentation d’un site Discourse. L’interface utilisateur est assez simple, vous cochez la case lors de la création de la page indiquant que cette page est de la documentation. Maintenant, il vous demande simplement quelle est la page parente. Pas de parent ? C’est un sujet de premier niveau. Vous définissez un parent, la page apparaît sous ce sujet/cette catégorie. Cela élimine complètement la nécessité de maintenir manuellement des pages d’index. Elles ressemblent à beaucoup de travail supplémentaire qui ne devrait pas être nécessaire. Et il est facile d’oublier d’ajouter des éléments au fur et à mesure qu’ils sont créés.
Si vous allez sur https://checkin.technospider.com et que vous dévoilez certains des éléments de la barre latérale, vous pouvez voir comment l’imbrication fonctionne dans un exemple concret. Toute cette barre latérale est générée dynamiquement simplement en imbriquant des pages sous d’autres pages (relation parent/enfant). Ce site n’a qu’environ 150 pages, mais il m’aurait fallu deux fois plus de temps pour le terminer si j’avais dû créer des index pour tout cela.
Et cela m’amène à un problème d’interface utilisateur/expérience utilisateur concernant la disposition de la barre latérale des Docs. Une fois que vous cliquez loin de la page principale, vous perdez la liste initiale des catégories. Vous devriez avoir un moyen de revenir sur la page quelque part.
Chacune de vos 8 zones principales devrait avoir des triangles de dévoilement, donc que vous cliquiez sur la case de la page principale ou sur le nom dans la barre latérale, cela se déroule simplement et vous ne perdez pas la possibilité de cliquer directement sur une autre des zones principales.
Vous avez un fil d’Ariane sur chaque article final, mais même cela manque pour les 8 catégories. Cliquer sur ‘supprimer le filtre’ des sous-catégories en haut de la page me ramène, mais c’est très peu intuitif. Et vous pouvez faire des choses étranges en jouant avec les filtres, par exemple, la jolie bannière verte disparaît si vous cliquez sur ‘pas de sous-catégories’.
Oui, c’est pour les sujets de gestion de site, la page d’index est ici. (index est une étiquette qui révèle toutes les pages d’index)
Je suis d’accord, cela a dû demander beaucoup de travail pour rassembler tous les liens des pages et les organiser joliment par catégories avec des étiquettes. Mais le résultat est tellement agréable et utilisable !
Ça a certainement l’air bien, mais comme je l’ai dit, il y a quelques problèmes d’utilisabilité en ce qui concerne la navigation.
Et si le travail peut être éliminé, cela semble être une victoire pour tout le monde.
Je ne critique pas le travail effectué, il a l’air très bien et comme je ne sais pas coder pour sauver ma vie, je ne peux même pas commencer à apprécier la quantité de travail qu’il a fallu, ni la quantité de travail supplémentaire que mes suggestions représenteraient.
C’est bien pour la documentation minimale, mais il manque beaucoup de balisage que j’ai utilisé sur le wiki auquel j’ai lié. À moins que je ne le rate. Je suis encore assez nouveau sur Discourse.
Par exemple, je ne trouve aucun moyen de créer des boîtes d’information/d’avertissement/d’erreur.
Ici sur Meta, des citations et des emojis sont utilisés.
Peut-être que ce Theme component, qui offre des styles alternatifs, correspond à vos besoins :
Pour les auto-hébergeurs utilisant ce plugin, notre dernière mise à jour nécessiterait une reconstruction manuelle de l’index. Cela impliquerait l’exécution de cette tâche rake :
bundle exec rake doc_categories:build_sidebar
# si l'exécution de la tâche ci-dessus échoue en raison de NoDatabaseError,
# exécutez avec la commande suivante pour les configurations auto-hébergées typiques
sudo -E -u discourse bundle exec rake doc_categories:build_sidebar
Si vous ne parvenez pas à exécuter cette tâche rake, vous pouvez accéder aux paramètres de chaque catégorie de documentation, supprimer l’index de la catégorie, enregistrer, le rajouter, puis enregistrer. Cela les reconstruira et actualisera également le cache de la catégorie.
Pourquoi faisons-nous cela ?
Auparavant, lorsque la barre latérale devait être remplie, nous analysions chaque sujet d’index à la volée et les mettions en cache. Cette mise à jour déplace les index existants pour qu’ils soient pris en charge par la base de données au lieu d’un sujet. Ce faisant, notre équipe dispose de plus d’options pour améliorer l’expérience utilisateur de l’organisation de l’index.