Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Tragen Sie zu diesem Leitfaden bei
Jeder kann zum Best-Practice-Leitfaden beitragen. Der EKS Best Practices Guide ist in dem AsciiDoc Format auf verfasst GitHub.
Zusammenfassung für bestehende Mitwirkende
-
Öffnen Sie das
bpg-docs.code-workspacemit VS Code, um die AsciiDoc Erweiterung automatisch zu installieren. -
Erfahren Sie mehr über die AsciiDoc Erweiterung
auf dem Visual Studio Marketplace.
-
-
Die Quelldateien für die AWS Docs-Website werden gespeichert in
latest/bpg -
Die Syntax ist Markdown sehr ähnlich.
-
Lesen Sie die Syntaxreferenz
in den AsciiDoctor Dokumenten.
-
-
Die Docs-Plattform wird nur bereitgestellt.
latest/bpg/imagesJeder der Leitfadenabschnitte enthält einen symbolischen Link zurück zu diesem Verzeichnis. Zeigt zum Beispiellatest/bpg/networking/imagesauflatest/bpg/images.
Richten Sie eine lokale Bearbeitungsumgebung ein
Wenn Sie das Handbuch häufig bearbeiten möchten, richten Sie eine lokale Bearbeitungsumgebung ein.
Forke und klone das Repo
Sie müssen mitgit, github und Texteditoren vertraut sein. Informationen zu den ersten Schritten mit git und github finden Sie in den GitHub Dokumenten unter Erste Schritte mit Ihrem GitHub Konto
-
Erstellen Sie einen Fork des Projekt-Repos. In den GitHub Dokumenten erfahren Sie, wie Sie ein Repository
forken. -
Klonen Sie Ihren Fork des Projekt-Repositorys. Erfahre, wie du dein geforktes Repository klonen kannst
.
Öffnen Sie den VS Code Workspace
AWS empfiehlt, Visual Studio Code von Microsoft zu verwenden, um den Leitfaden zu bearbeiten. Weitere Informationen zu VS Code finden Sie unter Visual Studio Code herunterladen
-
Öffnen Sie VS Code.
-
Öffnen Sie die
bpg-docs.code-workspaceDatei aus dem geklonten Repo. -
Wenn Sie diesen Arbeitsbereich zum ersten Mal öffnen, akzeptieren Sie die Aufforderung zur Installation der AsciiDoc Erweiterung. Diese Erweiterung überprüft die Syntax von AsciiDoc Dateien und generiert eine Live-Vorschau.
-
Navigieren Sie zum
latest/bpgVerzeichnis. Dieses Verzeichnis enthält die Quelldateien, die auf der AWS-Dokumentationsseite bereitgestellt werden. Die Quelldateien sind nach Abschnitten mit Anleitungen wie „Sicherheit“ oder „Netzwerk“ gegliedert.
Bearbeiten einer Datei
-
Öffnen Sie eine Datei im Editor.
-
In der AsciiDoc Syntax erfahren Sie, wie Sie Überschriften, Links und Listen erstellen.
-
Sie können die Markdown-Syntax verwenden, um Text zu formatieren, Listen und Überschriften zu erstellen. Sie können die Markdown-Syntax nicht verwenden, um Links zu erstellen.
-
-
Öffnen Sie eine Live-Vorschau der Seite.
-
Drücken Sie zunächst
ctrl-kodercmd-k(je nach Tastatur). Zweitens drücken Siev. Dadurch wird eine Vorschau in geteilter Ansicht geöffnet.
-
AWS schlägt vor, Feature-Branches zu verwenden, um Ihre Änderungen zu organisieren. Erfahren Sie, wie Sie mit Git Branches erstellen.
Reichen Sie eine Pull-Anfrage ein
Sie können eine Pull-Anfrage von der GitHub Website oder der GitHub CLI aus erstellen.
Erfahre, wie du mithilfe der GitHub Website eine Pull-Anfrage von einem Fork aus erstellst
Erfahre, wie du mithilfe der GitHub CLI eine Pull-Anfrage erstellst
Verwenden Sie den webbasierten Editor github.dev
Der github.dev webbasierte Editor basiert auf VS Code. Dies ist eine hervorragende Möglichkeit, mehrere Dateien zu bearbeiten und eine Vorschau von Inhalten ohne Einrichtung anzuzeigen.
Es unterstützt die AsciiDoc Erweiterung. Sie können Git-Operationen mit der GUI ausführen. Der webbasierte Editor verfügt weder über eine Shell noch über ein Terminal zum Ausführen von Befehlen.
Sie müssen ein GitHub Konto haben. Bei Bedarf werden Sie aufgefordert, sich anzumelden.
🚀 Starten Sie den GitHub webbasierten Editor.
Bearbeiten Sie eine einzelne Seite
Sie können einzelne Seiten schnell aktualisieren, indem Sie GitHub Jede Seite enthält unten den Link GitHub "📝 Diese Seite bearbeiten auf".
-
Navigieren Sie zu der Seite in diesem Handbuch, die Sie bearbeiten möchten
-
Klicken Sie unten auf den Link GitHub „Diese Seite bearbeiten auf“
-
Klicken Sie oben rechts im GitHub Dateiviewer auf das Bleistiftsymbol „Bearbeiten“ oder drücken Sie
e -
Bearbeiten Sie die Datei
-
Reichen Sie Ihre Änderungen mit der Schaltfläche „Änderungen übernehmen...“ ein. Diese Schaltfläche erstellt einen GitHub Pull-Request. Die Betreuer des Leitfadens werden diesen Pull-Request überprüfen. Ein Prüfer wird den Pull-Request genehmigen oder Änderungen beantragen.
Die ID für eine Seite anzeigen und festlegen
Auf dieser Seite wird erklärt, wie die Seiten-ID angezeigt und festgelegt wird.
Die Seiten-ID ist eine eindeutige Zeichenfolge, die jede Seite auf der Dokumentationsseite identifiziert. Sie können die Seiten-ID in der Adressleiste Ihres Browsers sehen, wenn Sie sich auf einer bestimmten Seite befinden. Die Seiten-ID wird für die URL, den Dateinamen und zum Erstellen von Querverweislinks verwendet.
Wenn Sie sich diese Seite ansehen, sieht die URL in der Adressleiste Ihres Browsers beispielsweise wie folgt aus:
https://docs.aws.amazon.com/view-set-page-id.html
Der letzte Teil der URL (view-set-page-id) ist die Seiten-ID.
Stellen Sie die Seiten-ID ein
Wenn Sie eine neue Seite erstellen, müssen Sie die Seiten-ID in der Quelldatei festlegen. Die Seiten-ID sollte eine kurze Zeichenfolge mit Bindestrich sein, die den Seiteninhalt beschreibt.
-
Öffnen Sie die Quelldatei für Ihre neue Seite in einem Texteditor.
-
Fügen Sie am Anfang der Datei die folgende Zeile hinzu. Sie sollte über der ersten Überschrift stehen.
[#my-new-page]my-new-pageErsetzen Sie es durch die Seiten-ID für Ihre neue Seite. -
Speichern Sie die Datei.
Anmerkung
Die Seite IDs muss auf der gesamten Dokumentationsseite eindeutig sein. Wenn Sie versuchen, eine vorhandene Seiten-ID zu verwenden, wird ein Erstellungsfehler angezeigt.
Erstelle eine neue Seite
Erfahren Sie, wie Sie eine neue Seite erstellen und das Inhaltsverzeichnis des Leitfadens aktualisieren.
Seitenmetadaten erstellen
-
Ermitteln Sie den Seitentitel und den Kurztitel der Seite. Der Kurztitel der Seite ist optional, wird jedoch empfohlen, wenn der Seitentitel mehr als ein paar Wörter umfasst.
-
Ermitteln Sie die ID der Seite. Dies muss innerhalb des EKS Best Practices Guide eindeutig sein. Die Konvention besteht darin, ausschließlich Kleinbuchstaben und separate Wörter mit
-zu verwenden. -
Erstellen Sie eine neue ASCIIDOC-Datei, falls erforderlich, in einem Ordner, und fügen Sie der Datei den folgenden Text hinzu:
[.“ Thema "] [#<page-id>] = <page-title>:info_titleabbrev: < > page-short-title
Zum Beispiel
[.“ topic "] [#scalability] = Bewährte Methoden zur Skalierbarkeit von EKS: info_titleabbrev: Skalierbarkeit
Zum Inhaltsverzeichnis hinzufügen
-
Öffnen Sie die Datei für die übergeordnete Seite im Inhaltsverzeichnis. Für neue Leitfäden auf oberster Ebene lautet die übergeordnete Datei
book.adoc. -
Aktualisieren Sie am Ende der übergeordneten Datei die folgende Anweisung und fügen Sie sie ein:
beinhalten: <new-filename>[leveloffset=+1]
Zum Beispiel
beinhalten: :dataplane.adoc [leveloffset=+1]
Fügen Sie ein Bild ein
-
Suchen Sie das Bildpräfix für die Seite, die Sie bearbeiten. Überprüfen Sie die
:imagesdir:Eigenschaft in der Überschrift der Datei. Zum Beispiel`:imagesdir: images/reliability/ -
Platzieren Sie Ihr Bild in diesem Pfad, z. B.
latest/bpg/images/reliability -
Ermitteln Sie den passenden Alt-Text für Ihr Bild. Schreiben Sie eine kurze allgemeine Beschreibung des Bildes. Beispielsweise ist „Diagramm einer VPC mit drei Verfügbarkeitszonen“ ein geeigneter Alt-Text.
-
Aktualisieren Sie das folgende Beispiel mit dem Alt-Text und dem Bilddateinamen. Fügen Sie es an der gewünschten Stelle ein.
Bild:: <image-filename>[< image-alt-text >]
Zum Beispiel
image:: eks-data-plane-connectivity .jpeg [Netzwerkdiagramm]
Überprüfen Sie den Stil mit Vale
-
Führen Sie Folgendes aus:
vale sync -
Installieren Sie die Vale-Erweiterung
vom Visual Studio Marketplace. -
Starten Sie VS Code neu und öffnen Sie eine AsciiDoc Datei
-
VS Code unterstreicht problematischen Text. In den VS Code-Dokumenten erfahren Sie, wie Sie mit Fehlern und Warnungen
arbeiten.
Erstellen Sie eine lokale Vorschau
-
Installieren Sie das
asciidoctorToolbrewunter Linux oder macOS-
In den Dokumenten erfahren Sie, wie Sie asciidoctor cli installieren
. AsciiDoctor -
Erfahren Sie, wie Sie den Brew-Paketmanager installieren
.
-
-
Öffnen Sie ein Terminal und navigieren Sie zu
latest/bpg/ -
Führen Sie Folgendes aus:
asciidoctor book.adoc-
Überprüfen Sie alle Syntaxwarnungen und Fehler
-
-
Öffnen Sie die
book.htmlAusgabedatei.-
Unter macOS können Sie ausführen,
open book.htmlum die Vorschau in Ihrem Standardbrowser zu öffnen.
-
AsciiDoc Spickzettel
Grundlegende Formatierung
*bold text*
_italic text_
`monospace text`Überschriften
= Document Title (Header 1)
== Header 2
=== Header 3
==== Header 4
===== Header 5
====== Header 6Listen
Ungeordnete Listen:
- Item 1
- Item 2
-- Subitem 2.1
-- Subitem 2.2
- Item 3Geordnete Listen:
. First item
. Second item
.. Subitem 2.1
.. Subitem 2.2
. Third itemLinks
External link: https://example.com[Link text]
Internal link: <<page-id>>
Internal link: xref:page-id[Link text]Bilder
image::image-file.jpg[Alt text]
Code-Blöcke
[source,python]
----
def hello_world():
print("Hello, World!")
----Tabellen
Erfahren Sie, wie Sie eine einfache Tabelle erstellen.
[cols="1,1"]
|===
|Cell in column 1, row 1
|Cell in column 2, row 1
|Cell in column 1, row 2
|Cell in column 2, row 2
|Cell in column 1, row 3
|Cell in column 2, row 3
|===Ermahnungen
NOTE: This is a note admonition.
WARNING: This is a warning admonition.
TIP: This is a tip admonition.
IMPORTANT: This is an important admonition.
CAUTION: This is a caution admonition.Vorschau:
Anmerkung
Dies ist eine kurze Ermahnung.
Umfasst
include::filename.adoc[]