Möglichkeiten zur Mitarbeit an der Dokumentation

[hugh (Hugh Lashbrooke)]

Die Discourse-Dokumentation ist der primäre Ort für Administratoren, Moderatoren, Benutzer und Sysadmins, um Hilfe bei der Verwendung von Discourse und der Verwaltung ihrer Websites zu finden.

Obwohl diese Dokumentation robust ist und viel abdeckt, gibt es einige fehlende Bereiche, die wir noch nicht dokumentiert haben. Dies ist eine großartige Gelegenheit für die Community, sich zu beteiligen und zu diesem wichtigen Teil des Discourse-Projekts beizutragen.

Wir würden uns freuen, wenn sich mehr Menschen an der Erstellung von Dokumentationsinhalten für Discourse beteiligen würden, und möchten es jedem so einfach wie möglich machen, dies zu tun. Zu diesem Zweck finden Sie unten eine Liste von Discourse-Funktionen oder Anwendungsfällen, bei denen wir festgestellt haben, dass neue oder verbesserte Dokumentationen erforderlich sind.

Dokumentationsorte

Jeder mit Vertrauensstufe 2 oder höher kann neue Dokumentationsthemen in Community wiki erstellen – dies ist die Heimat aller von der Community beigesteuerten Dokumentationsinhalte. Wenn ein Thema im Community-Wiki als relevant oder wichtig erachtet wird, kann es nach Documentation verschoben werden – die Heimat aller offiziellen Discourse-Dokumentationen. Sie können die Dokumentationsrichtlinie lesen, um weitere Details zu erfahren.

Abzeichen für Dokumentationsmitwirkende

Jeder, der ein neues Thema in der Kategorie Community wiki erstellt, erhält automatisch das bronzene Abzeichen “Scribe”:

Wenn das Thema als wertvoll genug erachtet wird, um in die offizielle Kategorie Documentation verschoben zu werden, wird dies von einem Mitglied des Discourse-Teams manuell durchgeführt, der ursprüngliche Autor im Thema gutgeschrieben und ihm das silberne Abzeichen “Ghostwriter” zugewiesen:

Zu schreibende Dokumentation

Obwohl wir letztendlich möchten, dass jeder Teil von Discourse gründlich dokumentiert wird, sind dies die Bereiche, bei denen wir den dringendsten Bedarf festgestellt haben (durchgestrichene Elemente zeigen Themen an, die seit der ersten Veröffentlichung dieses Beitrags geschrieben wurden):

• Ein allgemeines Tutorial für Administratoren zum Einstieg
• Benutzerdefinierte Themenumleitungen
• Erklärung, was verschiedene Benutzerebenen tun können
• Optionen für soziale Anmeldungen
• Beiträge ankündigen (offizielle Doku)
• Weitere Dokumentation darüber, wie Vertrauensstufen funktionieren
• Wie man eine gute Feature-Anfrage für Discourse schreibt (Wiki-Thema)
• Eine Referenz, wie Discourse-Markdown und Formatierungsfunktionen in E-Mails aussehen
• Benutzerstatus (Wiki-Thema)
• Erklärung des Dunkelmodus, wie man ihn auswählt und wie man das Umschalten aktiviert (Wiki-Thema)
• Allgemeine Dokumentation zur Verwaltung von Benutzereinstellungen (Wiki-Thema)
• Doku, die erklärt, wie Kategorien und Hierarchien in Discourse funktionieren
• Ein allgemeiner Leitfaden für Themeneinstellungen
• Ein allgemeiner Leitfaden zu Plugins – was sie sind, wie sie funktionieren und wie man sie verwendet
• Benutzerdefinierte Startseiten
• Ändern von Standardkategorien und -themen
• Verwendung von Bildrastern in Beiträgen (Wiki-Thema)
• Einstellungen für Beitragsgenehmigungen (Wiki-Thema)

Einige davon erfordern möglicherweise mehrere Themen, um effektiv dokumentiert zu werden.

Wie man Dokumentation schreibt

Um sicherzustellen, dass die Discourse-Dokumentation so effektiv wie möglich ist, haben wir einen Styleguide für die Erstellung dieser Inhalte. Obwohl es hilfreich wäre, wenn jeder den Leitfaden befolgt, ist es kein Problem, wenn Sie ihn nicht vollständig einhalten, wenn Sie zu Community wiki beitragen. Alle Themen, die nach Documentation verschoben werden, werden vom Discourse-Team nach Bedarf aktualisiert, um dem Styleguide zu entsprechen.

Interessiert?

Springen Sie zu Community wiki und beginnen Sie noch heute mit der Dokumentation. Wenn Sie etwas davon besprechen möchten, können Sie gerne auf dieses Thema antworten, um darüber zu sprechen.

[Moin]

Was ist mit den bestehenden Themen? Zum Beispiel

@hugh

How to grant admin or moderator privileges to users

Promoting a User to Admin or Moderator Status

This is a how-to guide intended to help existing site admins understand how to promote a user to admin or moderator status through Discourse. Required user level: Administrator Admin privileges in Discourse are powerful and allow the user to manage almost all aspects of the site. For full details on what staff users can do on a site, see Understanding user statuses, roles, and permissions. Here is a step-by-step process on how to promote a user to admin or …

@hugh

How to write a good feature request for Discourse

Requesting new features for Discourse

This guide explains how to request new features for Discourse, check existing plans, and increase the chances of your feature request being prioritized. Required user level: Anyone can submit a feature request Got a great idea for a Discourse feature? That’s fantastic! Here’s how you can share it with the team effectively. Make sure your feature isn’t already made or planned Before submitting a new feature request, ensure it’s not already available or plann…

[hugh (Hugh Lashbrooke)]

Für diese hier:

@Moin

@hugh

How to write a good feature request for Discourse

Requesting new features for Discourse

Die bestehende Dokumentation spricht darüber, wie man neue Funktionen anfordert, aber nicht darüber, wie man eine gute Anfrage formatiert, um sie effektiver zu gestalten. Wir verlinken derzeit auf diese Seite, aber es wäre gut, wenn wir diese Art von Inhalten stattdessen auf Meta hätten.

Und für diese hier:

@Moin

@hugh

How to grant admin or moderator privileges to users

Grant Admin or Moderator Privileges to a User

Guter Fang! Ich werde das aus der Liste in diesem Thema entfernen

[ondrej]

@hugh

Wie man eine gute Funktionsanfrage für Discourse schreibt

Es gibt bereits dieses Thema, das Funktionsanfragen behandelt

Requesting new features for Discourse

This guide explains how to request new features for Discourse, check existing plans, and increase the chances of your feature request being prioritized. Required user level: Anyone can submit a feature request Got a great idea for a Discourse feature? That’s fantastic! Here’s how you can share it with the team effectively. Make sure your feature isn’t already made or planned Before submitting a new feature request, ensure it’s not already available or plann…

Es sei denn, es soll so aussehen, aber für eine Funktionsanfrage?

Writing an effective bug report

This is a guide for writing effective bug reports in Discourse to maximize the chances of getting bugs fixed. Required user level: Any can report a bug Writing a good bug report is essential to help the Discourse team fix issues efficiently. This guide will walk you through the steps and best practices to ensure your bug report is clear, concise, and actionable. Summary In this documentation, we’ll cover: The importance of providing reproducible steps and…

[HamMan2118]

@hugh

Post notices

Bedeutet das „Mitarbeiterhinweis“ oder etwas anderes?

[ondrej]

Ich gehe davon aus, dass dies eine Beitragsmitteilung ist, da sie im Titel steht

Post notices for first-time and returning users

To encourage kindness towards users who are posting for the first time or may not have posted in a while we’ve created a new feature that calls special attention to these new/returning users. These banners are visible to other users, but not the poster they apply to… and by default are only visible to community members who have been active enough to achieve Trust Level 2. Here’s what they look like: [image] [image] How can I configure this feature? Admins can adjust these options in their…

Mitarbeitermitteilungen sind im Grunde dasselbe, nehme ich an?

[hugh (Hugh Lashbrooke)]

@ondrej

Es sei denn, es soll so aussehen, aber für eine Feature-Anfrage?

Ja, das ist es, was wir dort suchen

@HamMan2118

@hugh

Post notices

Bedeutet das Staff Notice oder etwas anderes?

Wie @ondrej verlinkt hat, sind Post Notices das, was in dieser Ankündigung beschrieben wird. Wir haben dieses Ankündigungsthema, aber keine tatsächliche Dokumentation dazu.

[Heliosurge (Dan DeMontmorency)]

Hallo Hugh, das ist eine tolle Idee.

Ich wollte schon seit Längerem eine Idee für das Community-Wiki vorstellen, um eine Art Tag für Forum-Vorlagen zu haben.

Die Idee, die ich dafür habe. Oft fragen Leute, wie sie Discourse für Dinge wie ein Support-Forum, eine Lernplattform usw. nutzen können. Manchmal sogar für obskurere Zwecke wie ein Tabletop-Rollenspiel.

Wenn wir Inhalte aus solchen Themen sammeln und uns verschiedene Anwendungsfälle überlegen. Könnten wir eine neue Ressource mit einem Hauptthema erstellen, das als Index dient.

• Vorlagen für Support-Foren
• Vorlagen für Lernplattformen

Diese Themen können gehostet werden von Discourse, Communique (so?) usw. mit empfohlenen Plugins und Theme-Komponenten usw. sowie einem Beitrag für Self-Hosted.

Gehostete Vorlagen würden sich auf die Plugins konzentrieren und angeben, welche Pläne für die Verwendung eines bestimmten Plugins benötigt werden.

Mit Tipps und Tricks und sogar Verweisen auf den Marketplace, wenn sie ein benutzerdefiniertes Layout, ein Plugin usw. benötigen.

[NateDhaliwal]

@hugh

Benutzerstatus

Erstellt:

Custom User Statuses

Summary This document covers: What a Custom User Status Is How to add, modify, and remove a custom user status. Custom User Status Description A Custom User Status is a feature where users can set a custom status and icon to appear in their profile and next to their avatar at posts. This can be used, as a member, to let the community know if you are unavailable, on vacation, or want to share how you are feeling. A custom user status appears like this in a post: [Username "andrei" with a pal…

[hugh (Hugh Lashbrooke)]

Das habe ich gesehen Toll zu sehen, dass diese eintreffen!

[NateDhaliwal]

Arbeite an der für den Dunkelmodus.

[NateDhaliwal]

Diese Anleitungen wurden bereits erstellt, aber noch nicht abgehakt:

@hugh

Benutzerstatus

Custom User Statuses

Summary This document covers: What a Custom User Status Is How to add, modify, and remove a custom user status. Custom User Status Description A Custom User Status is a feature where users can set a custom status and icon to appear in their profile and next to their avatar at posts. This can be used, as a member, to let the community know if you are unavailable, on vacation, or want to share how you are feeling. A custom user status appears like this in a post: [Username "andrei" with a pal…

@hugh

Verwendung von Bildrastern in Beiträgen

Image Grids

This guide explains what Image Grids are and how to apply them in your posts. Required user level: Trust Level 0 Summary This document covers: Description of image grids How they can be applied in posts and how to modify them Basic Layout of image grids Image Grids Description An image grid places all of the images in your post into a neat, organized grid - rather than in a list. Below is an example of an image grid. [Delta A321-200 Landing in Washingt…

@hugh

Benutzerdefinierte Startseiten

Diese hier ist etwas unklar. Bezieht sie sich auf benutzerdefinierte Startseiteninhalte? Wenn ja, dann vielleicht Add custom content that only appears on your homepage. Andernfalls… wurde sie noch nicht geschrieben.

[hugh (Hugh Lashbrooke)]

Danke, dass Sie sich hier noch einmal gemeldet haben – ich habe die OP mit diesen Links aktualisiert.

@NateDhaliwal

This one is a bit blurry. Does it refer to custom homepage content?

Dies ist eine ziemlich spezielle Sache und bezieht sich auf die Erstellung einer benutzerdefinierten Homepage, also nichts, was die meisten Discourse-Administratoren verwenden werden. Es ist keine Hauptfunktion, da sie in diesem Stadium noch nicht vollständig ausgereift ist.