GNU/Linux >> LINUX-Kenntnisse >  >> Linux

Formatleitfaden für Atlantic.Net How-To-Artikel

Einführung

Wenn Sie glauben, dass Sie für Atlantic.Net schreiben möchten, sollten Sie damit beginnen, unser Anmeldeformular auszufüllen.

How-to-Artikel für Atlantic.Net sollten den in den folgenden Abschnitten angegebenen Standards entsprechen:

Abschnitte (einschließlich Einführung, Voraussetzungen und das Tutorial selbst)
Format (Markdown oder einfaches HTML)
Bilder/Screenshots
Originalarbeit

Weitere Hinweise finden Sie auch in unserem Styleguide.

Abschnitte

Jeder Anleitungsartikel sollte mit dem Einführungsabschnitt beginnen, der den Umfang des Artikels kurz beschreibt. Das Wort „Einführung“ sollte in H3-Überschriften enthalten sein.

Die folgende Einführung sollte Voraussetzungen sein, die mit H3-Überschriften gekennzeichnet sind. Zu den Voraussetzungen sollte gehören, für welches Betriebssystem der Artikel relevant ist, einschließlich der entsprechenden Distribution (z. B. „Ubuntu 14.04 und früher“ oder „Windows Server 2012 und Windows Server 2012 R2“).

Sie sollten auch Pakete, Rollen oder Features angeben, die erforderlich sind und deren Installation, und dieser Artikel wird nicht die Konfiguration behandeln. Vergewissern Sie sich, dass ein Artikel vorhanden ist, der diese Installation/Konfiguration abdeckt, und fügen Sie einen Link hinzu.

Beispiel:(Auszug aus Install WordPress on a Fedora 22 Cloud Server .)

Voraussetzung

– Ein Fedora 22-Server mit LAMP oder LEMP ist erforderlich. Bitte lesen Sie unsere Anleitungen für Fedora 22 LAMP oder LEMP.

Der Großteil des Artikels, das Tutorial, folgt dem Abschnitt Voraussetzungen.

Formatieren

Anleitungsartikel für Atlantic.Net können in Markdown oder einfachem HTML eingereicht werden.

Unterstützte Textformatierung:Kopfzeilentext, Codeblöcke, Inline-Code (für Befehle und Tastenanschläge), kursiv (für Variablen) und fett (zur Hervorhebung).

Überschriften

H2 sollte für größere Abschnitte des Tutorials verwendet werden.

H3 sollte für „Einführung“, „Voraussetzungen“ und Unterabschnitte des Tutorials verwendet werden.

Codeblöcke

Jeglicher Code, der als Teil des Tutorials eingegeben werden muss, sollte in einem Codeblock enthalten sein.

In den meisten Fällen wird Inline-Code verwendet, um Variablen oder Optionen zu erklären, die Befehle annehmen können. Wenn Sie inline auf Code verweisen, können Sie den code verwenden Schild. Diese Verwendung sollte darauf beschränkt sein, sich auf einen Teil des Codes zu beziehen, der bereits in einem nahegelegenen Codeblock enthalten ist.

Beispiel:

Seien Sie vorsichtig bei der Verwendung von -r Option mit rm . Es versucht rekursiv, alle Dateien zu löschen, die dem von Ihnen angegebenen Pfad untergeordnet sind.

Variables/benutzerdefiniertes Informationsformat

Platzhalter für Variablen oder benutzerdefinierte Konfigurationseinträge (z. B. Hostnamen) sollten kursiv dargestellt werden. Unser Parser färbt außerdem alle kursiv gedruckten Einträge grün .

Hervorhebung

Wenn Sie eine Hervorhebung angeben möchten, verwenden Sie fett .

Tastenanschläge

Wenn es darum geht, Tastenanschläge innerhalb des Textes zu referenzieren, schließen Sie sie in einen code span ein .

Beispiel:

Drücken Sie die Enter Schlüssel.

Verwenden Sie für Tastenanschläge, bei denen mehrere Tasten gleichzeitig gedrückt werden müssen, ein Pluszeichen (+) zwischen den Tasten.

Beispiel:

Drücken Sie zum Beenden Ctrl+C .

Um den Benutzer zu wechseln, drücken Sie zuerst Ctrl+Alt+Del .

.

Bilder

Anleitungen sollten geeignete Screenshots enthalten, die solche visuellen Elemente zeigen, wie z. B. wo geklickt werden muss oder wie ein Bildschirm aussehen sollte (z. B. eine phpinfo-Seite). Bilder sollten eine maximale Breite von 730 Pixel haben.

Bitte fügen Sie einen Link zum Bild mit der URL hinzu, unter der es derzeit gehostet wird. Bei zur Veröffentlichung angenommenen Artikeln werden alle zugehörigen Bilder heruntergeladen und auf unseren Servern gehostet. Zusammen mit Bildern benötigen wir Folgendes:

Bildname :Format anet-articlename-## (wobei der ## wird durch eine Zahl ersetzt, z. B. anet-how_to_install_lamp_debian_8-01 ).
Alt-Text :eine kurze Beschreibung des Bildes, falls es nicht geladen wird.
Bildunterschrift :kurze Beschreibung, die unter dem Bild erscheint.

Alle eindeutig identifizierbaren Informationen sollten unkenntlich gemacht werden, vorzugsweise durch die Verwendung auffälliger Platzhalternamen (wie „example.com“ oder „192.168.0.2“).

Originalarbeit

Alle für Atlantic.Net geschriebenen Artikel müssen Originalarbeiten sein. Wenn Sie bereits an anderer Stelle ein bestimmtes Tutorial geschrieben haben und etwas Ähnliches mit uns machen möchten, nutzen Sie diese Gelegenheit, um Ihre anfänglichen Bemühungen zu verbessern! Atlantic.Net toleriert weder Plagiate noch die Wiederverwendung bereits vorhandener Arbeiten.

Ebenso sollten alle Bilder und Screenshots einzigartig sein.

Erfahren Sie mehr über unsere VPS-Hosting-Services und den VPS-Hosting-Preis.


Linux
  1. Bash For Loop Guide und Beispiele

  2. 10 Containerleitfäden für Systemadministratoren

  3. Linux – Welches Dateisystem sollte ich bei der Installation von Linux auf einem USB-Laufwerk verwenden, um die beste Leistung zu erzielen?

  4. Gewusst wie:Style Guide für Atlantic.Net-Artikel

  5. Formatleitfaden für Atlantic.Net What-Is-Artikel

Atlantic.Net Cloud – Wie kann ich meine Kundeninformationen für mein Cloud-Konto aktualisieren?

Atlantic.Net Cloud – Kann ich meinen Cloud-Server vergrößern?

Atlantic.Net Cloud – So stellen Sie einen Cloud-Server neu bereit

Atlantic.Net – Leitfaden für VPN-Verbindungen

So richten Sie Atlantic.Net E-Mail ein

Atlantic.Net Trusted Access – Leitfaden zur Multi-Faktor-Authentifizierung