Categorie Doc Discourse

Potrei pensare che la confusione e la difficoltà derivino dal fatto che l’argomento indice debba essere in un certo formato, e questo non è completamente chiarito nella documentazione (post principale)

Avevo installato questo plugin da solo, seguendo attentamente le istruzioni, ma non funzionava esattamente nello stesso modo in cui lo stava sperimentando @dennisjbr.

Potrebbe essere utile avere un esempio del Markdown richiesto anziché collegarsi all’esempio di Meta, perché l’unica regola fondamentale è che deve esserci un elenco puntato/numerato in Markdown. La documentazione dice “un elenco”, ma la parola “elenco” ha un uso comune in inglese che include elenchi non in Markdown!

Questo funzionerà come argomento indice:

* https://meta.discourse.org/t/discourse-doc-categories/322376
* Testo arbitrario: https://meta.discourse.org/t/discourse-doc-categories/322376

Questo non funzionerà:

https://meta.discourse.org/t/discourse-doc-categories/322376
Testo arbitrario: https://meta.discourse.org/t/discourse-doc-categories/322376

Oltre a questo, puoi usare le intestazioni Markdown per creare sezioni e usare più elenchi, ma nulla apparirà nella barra laterale a meno che non ci sia un elenco Markdown. Apprezzo che questo sia un po’ ovvio e potrebbe non aver creato problemi a nessun altro, ma ha creato problemi a me (stupidamente o meno) e non sono nuovo a Discourse, TC e Plugin.

5 Mi Piace

Ho aggiunto un esempio più esplicito di un argomento di indice formattato al post originale qui: https://meta.discourse.org/t/discourse-doc-categories/322376#p-1584993-formatting-index-topics-4

Dai un’occhiata e fammi sapere se non riesci ancora a risolvere.

8 Mi Piace

Sembra buono a me @hugh!

3 Mi Piace

Ho una persona AI per la mia categoria di documentazione. Ci sono stati dei pensieri sulla possibilità di rendere disponibile una persona AI per gli anonimi? Penso almeno, in una chat DM temporanea e anonima? È anche possibile?

Quando visiti una pagina molto in basso nell’indice (richiede lo scorrimento per raggiungerla), anche la pagina principale viene fatta scorrere verso il basso fino a una posizione intermedia: ad esempio su questo elemento della documentazione

2 Mi Piace

Grazie per averlo evidenziato! Vedremo cosa possiamo fare per evitarlo in futuro.

3 Mi Piace

In realtà, non si dovrebbe mai considerare qualcosa “ovvio” quando si documenta qualcosa. Questo tipo di feedback è vitale in qualsiasi tipo di progetto per garantirne la chiarezza.

Qualsiasi cosa scritta avrà tipicamente senso per l’autore grazie alla sua profonda comprensione di ciò che ha scritto. Per gli altri, al contrario, potrebbe essere meno chiara.

Io stesso non amo termini come “intuitivo” poiché qualcosa è intuitivo solo se si ha esperienza nell’uso di qualcosa di simile.

7 Mi Piace

Grazie! Questo aiuta molto.

Ottimo lavoro a tutti per questo plugin!!

Sono un NOOB, quindi mi scuso in anticipo! Ho cercato di capirlo da solo per un po’ ma non riesco a trovare una soluzione da nessuna parte. :frowning:

Sto cercando di usare questo plugin come un modo per organizzare i progetti individuali degli utenti a livello di categoria.

Stiamo cercando di creare un forum che avrà un sacco di diversi progetti utente. Originariamente li avevamo tutti sotto la categoria “progetti”, quindi quando qualcuno cliccava su progetti vedeva tutte le caselle delle sottocategorie che elencavano tutti i progetti individuali in un’interfaccia utente dall’aspetto gradevole (una sorta di marketplace di progetti).
Ma facendo così perdiamo quel livello di organizzazione dei dati perché i progetti individuali iniziano come sottocategorie invece che come categorie.

Ero super entusiasta quando ho trovato questo plugin perché ho pensato che sarebbe stato perfetto per organizzare tutti i progetti a livello di categoria, permettendoci di avere una migliore organizzazione dei dati all’interno dei progetti.

Quindi ora sto creando progetti individuali come categorie individuali (esca da pesca, progetto 2, progetto 3) e usando il plugin delle categorie di documenti per creare fondamentalmente un indice di tutti i progetti in modo che le persone possano cliccare sulla nuova categoria progetti gestita dal plugin delle categorie di documenti e usare il menu a discesa per navigare tra le sottocategorie e gli argomenti che scegliamo di elencare nell’argomento dell’indice.

C’è un modo per visualizzare le categorie nella colonna centrale in modo che assomigli alla visualizzazione della pagina “tutte le categorie” nel normale feed di discourse?

Voglio che quando clicco sulla categoria di documenti dei progetti, elenchi tutti i progetti a sinistra nel menu, ma li visualizzi anche nelle caselle nel feed principale, proprio come fa normalmente con le sottocategorie. Mi è stato permesso di mettere solo un’immagine in questo post, quindi ho messo l’immagine dei progetti nel menu a sinistra e vorrei avere le caselle delle categorie che mostrano al centro, dove il mio post sull’argomento sta mostrando.

Grazie in anticipo per qualsiasi aiuto e guida.

3 Mi Piace

Puoi aggiungere “link relativi”, come “/t/topic/463”, che sarebbero molto efficaci per cambiare “nomi di dominio” senza molto lavoro.

1 Mi Piace

Attualmente non è molto lavoro. Basta fare una ricerca e sostituzione - quanto spesso cambi dominio?

2 Mi Piace

Questo sembra quello che abbiamo fatto qui su Meta per le sottocategorie di documentazione.

Puoi vedere le sottocategorie nella vista principale e sono anche collegate nella barra laterale qui: Documentation - Discourse Meta

Per far funzionare questo, abbiamo aggiunto un argomento di indice per la categoria padre di documentazione che include i collegamenti a ciascuna sottocategoria: Documentation Index.

Questo ti aiuta a trovare una buona soluzione nella tua istanza?

3 Mi Piace

Dato che il collegamento relativo funziona già. Perché non aggiungerlo ed eliminare qualsiasi lavoro non necessario? Questi sono collegamenti interni dopotutto e questo contribuirebbe alla parità di Discourse poiché i collegamenti interni funzionano anche con una varietà di TC e plugin.

1 Mi Piace

Grazie Hugh!
Quello che state facendo con le sottocategorie è sulla buona strada, ma volevo principalmente che l’interfaccia utente mostrasse le categorie nelle caselle nella colonna centrale, come fa con le sottocategorie.

Ho finito per trovare e installare il plug-in sub-sub-cat. Quindi ora lo sto usando per aiutarmi a raggruppare le sottocategorie in modo che agiscano effettivamente come “categorie” poiché abbiamo due livelli di distribuzione dei dati al di sotto di esse: sub-sub-cat e argomenti.
Ciò ha soddisfatto il mio obiettivo principale di aumentare la quantità di distribuzione dei dati e i livelli di organizzazione all’interno dei nostri progetti utente. Quindi ora sto usando le sub-sub-categorie insieme al plug-in per ottenere il meglio da entrambi i mondi a livello di categoria principale.
Stavo cercando di creare la categoria di progetto solo con il plug-in delle categorie duck, ma non ci è piaciuta l’interfaccia utente di avere solo un menu a sinistra e nulla al centro su cui l’utente potesse navigare. Quindi, volevo che i (progetti che sono categorie) venissero visualizzati all’interno di una Categoria (tutti i progetti) come le sottocategorie possono fare normalmente. (la mia immagine nell’ultimo post del mio mockup)

ecco la categoria principale dei progetti: BETA - avrà altre sottocategorie

ed ecco le “sub-sub-cat” al lavoro, che trasformano la sottocategoria in una categoria.
insieme alla facile navigazione dell’argomento dell’indice.


Grazie ancora per tutto il lavoro che state facendo.
Spero di essere stato un po’ più chiaro in questo post. :frowning:

Ho trovato una soluzione che ci soddisfa molto ed è una combinazione dei 2 plug-in.

2 Mi Piace

Sono contento che tu abbia trovato una soluzione che funzioni per te!

2 Mi Piace

Qual è il vantaggio di questo plugin rispetto al plugin di documentazione legacy?

Nel plugin legacy, posso avere documentazione in qualsiasi categoria, a condizione che mantenga i tag. Ora sembra che tutti gli argomenti di documentazione debbano risiedere sotto un’unica categoria. È corretto? In questo caso, si perde un po’ di contesto, poiché parte della documentazione (esistente) potrebbe essere influenzata da gruppi/categorie specifici (ad esempio, disponibile solo per lo Staff).

Potreste chiarire le differenze tra i due approcci, perché avete scelto questo approccio e come intendete colmare il divario tra il plugin legacy e quello nuovo? :heart:

Commento OT su "callouts"

HedgeDoc utilizza la seguente estensione Markdown per supportare i callout (li chiamano aree di avviso):

### Area di avviso

:::success
Sì :tada:
:::

:::info
Questo è un messaggio :mega:
:::

:::warning
Attenzione :zap:
:::

:::danger
Oh no! :fire:
:::

verrà visualizzato

(questo sarebbe abbastanza facile da stilizzare con CSS dato una classe).

Commento OT su pigrizia e AI

Riesci a immaginare l’eccesso di energia e acqua consumati per solo tre righe di Markdown che avresti potuto copiare e incollare manualmente? :slightly_frowning_face:

Commento OT su URL relativi vs. assoluti

In realtà, copiare e incollare gli URL degli argomenti è più facile, e se cambi i domini, probabilmente esporteresti/importeresti gli argomenti, e Discourse sostituirebbe il dominio per te.


Dopo aver sperimentato un po’, ecco le mie conclusioni (temporanee):

  1. L’utilizzo dell’argomento di descrizione della categoria per fornire un indice della documentazione è utile (ad esempio, Singular Docs - Documentation - petites singularités)
  2. Una categoria di documentazione di primo livello consente di utilizzare sottocategorie per modificare l’indice della barra laterale della documentazione (ad esempio, “Installare Ruby” appare sotto “Guide pratiche” in Documentation - petites singularités, ma sotto “Suggerimenti e trucchi” in Sysadmin Docs - petites singularités) per fornire una bella struttura (vedi Documentation qui, che visualizza le sottocategorie come riquadri)
  3. Gli argomenti di documentazione possono trovarsi ovunque nel forum, anche in spazi privati, sebbene l’indice della documentazione ne riveli l’esistenza.
  4. La barra laterale è attualmente instabile:
    • a volte visualizza gli URL, a volte il titolo
    • a volte solo testo con prefisso
    • quando si è disconnessi, potrebbe non visualizzare alcuni argomenti indicizzati
  5. Durante la migrazione dal plugin di documentazione legacy, il link alla documentazione deve essere ricreato nella sezione personalizzata della barra laterale (ma potrebbe essere generato automaticamente modificando /docs nella categoria di documentazione nelle impostazioni del plugin, o creando/modificando il permalink /docs per collegarsi a quella categoria)
  6. Il link “Torna al forum” sembra strano, perché gli argomenti di documentazione rimangono argomenti del forum: siamo ancora lì a leggere la documentazione!
  7. Il filtro non tiene ancora conto dei nomi delle (sotto)categorie a cui appartiene l’argomento di documentazione.
3 Mi Piace

L’ultimo aggiornamento introduce un piccolo bug nell’interfaccia utente quando è presente una barra di scorrimento.

Penso anche che questa casella di ricerca “filtro” sarebbe molto più efficace se fosse semplicemente una query di ricerca personalizzata nella categoria corrente per impostazione predefinita (invece di chiedere questo se non ci sono risultati). I titoli sono molto brevi, quindi nella maggior parte dei casi non ci sarà un riscontro per qualcosa che un utente non familiare digiterebbe lì.

Ma stai perdendo la normale barra laterale del “forum”, quindi tornare al forum ha un senso qui.

1 Mi Piace

Mi ci è voluto un po’ per capire che la barra laterale non appariva perché per qualche motivo l’impostazione del menu di navigazione era impostata su “menu a discesa nell’intestazione” invece che su “barra laterale”. Per coloro che non sono riusciti a far apparire la barra laterale, questo potrebbe essere il motivo.

Ora sono bloccato nel cercare di capire come aggiungere l’intestazione della categoria e le caselle della sottocategoria come vediamo qui:

Non riesco a vedere alcuna impostazione per abilitare/disabilitare ciò e purtroppo non sembra voler apparire.
Se qualcuno ha qualche idea, apprezzerei il suo parere.
Grazie.

1 Mi Piace
4 Mi Piace

La mancanza di filtraggio per tag riduce notevolmente l’utilità del plugin. In una community in cui un documento può applicarsi a più categorie, il filtraggio per tag è essenziale.

Ad esempio, un documento denominato “Assemblaggio Carrello di Atterraggio” si applica a più modelli di aeromobili e può contenere anche più tag. Trovare quello giusto è molto facile con il filtraggio per tag.

Se devi scegliere una categoria per il documento, cosa fai quando lo stesso documento dovrebbe trovarsi anche in altre categorie?

I tag erano l’indice automatico che ora deve essere creato e mantenuto manualmente.

6 Mi Piace