Opportunità di collaborazione documentation

La documentazione di Discourse è il luogo principale in cui amministratori, moderatori, utenti e sysadmin possono trovare aiuto sull’utilizzo di Discourse e sulla gestione dei propri siti.

Sebbene questa documentazione sia robusta e copra molti aspetti, ci sono alcune aree mancanti che non abbiamo ancora documentato. Questa è una grande opportunità per la community di contribuire a perfezionare questa importante parte del progetto Discourse.

Ci piacerebbe vedere più persone coinvolte nella creazione di contenuti di documentazione per Discourse e vogliamo rendere il più semplice possibile per chiunque farlo. A tal fine, di seguito è riportato un elenco di funzionalità o casi d’uso di Discourse che abbiamo identificato come richiedenti una documentazione nuova o migliorata.

:notebook_with_decorative_cover: Posizioni della documentazione

Chiunque abbia un livello di fiducia 2 o superiore può creare nuovi argomenti di documentazione in Community wiki questa è la sede di tutti i contenuti di documentazione contribuiti dalla community. Se un argomento nel wiki della community è considerato rilevante o importante, può essere spostato in Documentation, la sede di tutta la documentazione ufficiale di Discourse. Puoi leggere la policy di documentazione per maggiori dettagli.

:gift: Badge per i contributori della documentazione

Chiunque crei un nuovo argomento nella categoria Community wiki riceverà automaticamente il badge di bronzo Scribe:

Se l’argomento è considerato sufficientemente valido da essere spostato nella categoria ufficiale Documentation, qualcuno del team di Discourse lo farà manualmente, attribuirà il merito all’autore originale nel contenuto dell’argomento e gli assegnerà il badge d’argento Ghostwriter:

:eyes: Documentazione da scrivere

Sebbene alla fine desideriamo che ogni parte di Discourse sia documentata in modo approfondito, queste sono le aree che abbiamo identificato con la necessità più pressante (gli elementi barrati indicano argomenti che sono stati scritti da quando questo post è stato pubblicato per la prima volta):

  • Un tutorial generale di avvio per gli amministratori
  • Redirect di argomenti personalizzati
  • Spiegazione di cosa possono fare i diversi livelli utente
  • Opzioni di accesso social
  • Avvisi sui post (doc ufficiale)
  • Più documentazione su come funzionano i livelli di fiducia
  • Come scrivere una buona richiesta di funzionalità per Discourse (argomento wiki)
  • Un riferimento su come appaiono le funzionalità di markdown e formattazione di Discourse quando incluse nelle email
  • Stati utente (argomento wiki)
  • Spiegazione della modalità scura, come selezionarla e come abilitare il passaggio (argomento wiki)
  • Documentazione generale che copre la gestione delle preferenze utente (argomento wiki)
  • Documenti che spiegano come funzionano le categorie e la gerarchia in Discourse
  • Una guida generale per le impostazioni degli argomenti
  • Una guida generale sui plugin: cosa sono, come funzionano e come usarli
  • Pagine iniziali personalizzate
  • Modifica delle categorie e degli argomenti predefiniti
  • Utilizzo di griglie di immagini nei post (argomento wiki)
  • Impostazioni di approvazione dei post (argomento wiki)

Alcuni di questi potrebbero richiedere più argomenti per essere documentati efficacemente.

:pencil2: Come scrivere la documentazione

Per garantire che la documentazione di Discourse sia il più efficace possibile, abbiamo una guida di stile su come scrivere questi contenuti. Sebbene sarebbe utile che tutti seguissero la guida, se stai contribuendo a Community wiki, non è un problema se non la segui completamente. Qualsiasi argomento che viene spostato in Documentation verrà aggiornato dallo staff di Discourse per corrispondere alla guida di stile secondo necessità.

:bulb: Interessato?

Entra in Community wiki e inizia a documentare oggi stesso. Se vuoi discutere di qualcosa, sentiti libero di rispondere a questo argomento per parlarne.

12 Mi Piace

E per quanto riguarda gli argomenti esistenti? Ad esempio

4 Mi Piace

Per questo:\n\n[quote="Moin, post:8, topic:326614"]\n[quote="hugh, post:1, topic:326614"]\nCome scrivere una buona richiesta di funzionalità per Discourse\n[/quote]\n\nRichiesta di nuove funzionalità per Discourse \n[/quote]\n\nLa documentazione esistente parla di come richiedere nuove funzionalità, ma non di come formattare una buona richiesta per renderla più efficace. Attualmente linkiamo a questa pagina, ma sarebbe bello se potessimo avere quel tipo di contenuto su Meta.\n\nE per questo:\n\n[quote="Moin, post:8, topic:326614"]\n[quote="hugh, post:1, topic:326614"]\nCome concedere privilegi di amministratore o moderatore agli utenti\n[/quote]\n\nConcedi privilegi di amministratore o moderatore a un utente \n[/quote]\n\nBuona osservazione! Lo rimuoverò dall’elenco in questo argomento :slight_smile:

3 Mi Piace

C’è già questo argomento che copre le richieste di funzionalità

A meno che non debba assomigliare a questo, ma per una richiesta di funzionalità? :point_down: :eyes:

4 Mi Piace

Significa Avviso dello staff o qualcosa di diverso?

1 Mi Piace

Presumo che questo sia un avviso di post poiché è nel titolo

Gli avvisi dello staff sono fondamentalmente gli stessi, immagino?

3 Mi Piace

Sì, è quello che stiamo cercando lì :slight_smile:

Come collegato da @ondrej, gli avvisi sui post sono quelli delineati in questo annuncio. Abbiamo quell’argomento di annuncio, ma non la documentazione effettiva al riguardo.

4 Mi Piace

Ciao Hugh, questa è un’ottima idea.

Stavo pensando di presentare un’idea per la wiki della community per avere una sorta di tag per, diciamo, i modelli di forum.

L’idea che ho per questo. Spesso abbiamo persone che chiedono di usare Discourse per cose come un Forum di Supporto, una Piattaforma di Apprendimento, ecc. Anche a volte usi più oscuri come un GDR da tavolo.

Raccogliendo contenuti da argomenti come quelli e pensando anche a vari usi. Potremmo creare una nuova risorsa con un argomento principale utilizzato come indice.

  • Modelli di Forum di Supporto
  • Modelli di Piattaforma di Apprendimento

Questi argomenti possono ospitare Discourse, Communique (quindi?) ecc. con plugin consigliati e componenti tematici, ecc. Oltre a un post per l’auto-ospitato.

I modelli ospitati si concentreranno sui plugin e faranno riferimento ai piani necessari per un particolare plugin da utilizzare.

Con suggerimenti e trucchi e persino indirizzando le persone al Marketplace se hanno bisogno di un layout personalizzato, di un plugin, ecc.

3 Mi Piace

Fatto:

7 Mi Piace

Ho visto :smile: Fantastico vederli arrivare!

8 Mi Piace

Sto lavorando a quello per la modalità scura.

5 Mi Piace

Queste guide sono già state create ma non ancora spuntate:

Questa è un po’ confusa. Si riferisce a contenuti personalizzati della pagina iniziale? In tal caso, forse Add custom content that only appears on your homepage. Altrimenti… non è ancora stata scritta.

2 Mi Piace

Grazie per essere tornato qui: ho aggiornato l’OP con questi link.

Questa è una cosa piuttosto di nicchia e si riferisce alla creazione di una homepage personalizzata, quindi non è qualcosa che la maggior parte degli amministratori di Discourse utilizzerà. Non è una funzionalità principale, poiché non è qualcosa che è completamente rifinito in questa fase.

2 Mi Piace