Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Contribuisci a questa guida
Chiunque può contribuire alla guida sulle migliori pratiche. La Guida alle migliori pratiche EKS è scritta nel AsciiDoc formato su GitHub.
Riepilogo per i contributori esistenti
-
Apri
bpg-docs.code-workspacecon VS Code per installare automaticamente l' AsciiDoc estensione. -
Scopri di più sull'AsciiDoc estensione
su Visual Studio Marketplace.
-
-
I file sorgente per il sito Web AWS Docs sono archiviati in
latest/bpg -
La sintassi è molto simile a markdown.
-
Esamina il riferimento alla sintassi nei documenti
. AsciiDoctor
-
-
La piattaforma docs esegue solo la distribuzione.
latest/bpg/imagesCiascuna delle sezioni della guida contiene un collegamento simbolico a questa directory. Ad esempio,latest/bpg/networking/imagesindica.latest/bpg/images
Configura un ambiente di modifica locale
Se prevedi di modificare frequentemente la guida, configura un ambiente di modifica locale.
Fork e clona il repository
È necessario conoscere e utilizzare gli editor git di github testo. Per informazioni su come iniziare a usare git egithub, vedi Guida introduttiva al tuo GitHub account
-
Visualizza la guida alle migliori pratiche EKS su. GitHub
-
Crea un fork del repository del progetto. Scopri come eseguire il fork di un repository nei documenti.
GitHub -
Clona il fork del repository del progetto. Scopri come clonare il tuo repository biforcato
.
Apri l'area di lavoro VS Code
AWS consiglia di utilizzare Visual Studio Code di Microsoft per modificare la guida. Per ulteriori informazioni su VS Code, consulta Scarica Visual Studio Code
-
Apri VS Code.
-
Apri il
bpg-docs.code-workspacefile dal repository clonato. -
Se è la prima volta che apri questo spazio di lavoro, accetta la richiesta di installare l'estensione. AsciiDoc Questa estensione controlla la sintassi dei AsciiDoc file e genera un'anteprima dal vivo.
-
Naviga fino alla
latest/bpgdirectory. Questa directory contiene i file sorgente che vengono distribuiti nel sito di documentazione di AWS. I file sorgente sono organizzati per sezioni della guida, ad esempio «sicurezza» o «rete».
Modificare un file
-
Aprire un file nell'editor.
-
Visualizza la AsciiDoc sintassi per scoprire come creare titoli, link ed elenchi.
-
Puoi usare la sintassi Markdown per formattare il testo, creare elenchi e titoli. Non è possibile utilizzare la sintassi Markdown per creare collegamenti.
-
-
Apri un'anteprima dal vivo della pagina.
-
Per prima cosa, premi
ctrl-kocmd-k(a seconda della tastiera). In secondo luogo, premiv. Si apre un'anteprima in visualizzazione divisa.
-
AWS suggerisce di utilizzare i rami delle funzionalità per organizzare le modifiche. Scopri come creare rami con git.
Invia una Pull Request
Puoi creare una pull request dal GitHub sito Web o dalla GitHub cli.
Scopri come creare una pull request da un fork
Scopri come creare una pull request
Usa l'editor basato sul web github.dev
L'editor github.dev basato sul web è basato su VS Code. Questo è un ottimo modo per modificare più file e visualizzare in anteprima i contenuti senza alcuna configurazione.
Supporta l' AsciiDoc estensione. È possibile eseguire operazioni git utilizzando la GUI. L'editor basato sul web non dispone di una shell o di un terminale per l'esecuzione dei comandi.
È necessario disporre di un GitHub account. Se necessario, ti verrà richiesto di effettuare il login.
🚀 Avvia l'editor GitHub basato sul web.
Modifica una singola pagina
È possibile aggiornare rapidamente singole pagine utilizzando GitHub. Ogni pagina contiene un link "📝 Modifica questa pagina su GitHub" in basso.
-
Vai alla pagina di questa guida che desideri modificare
-
Fai clic sul link «Modifica questa pagina su GitHub» in basso
-
Fai clic sull'icona di modifica a forma di matita in alto a destra nel visualizzatore di GitHub file o premi
e -
Modifica il file
-
Invia le modifiche utilizzando il pulsante «Conferma modifiche...». Questo pulsante crea una GitHub pull request. I manutentori della guida esamineranno questa pull request. Un revisore approverà la pull request o richiederà delle modifiche.
Visualizza e imposta l'ID per una pagina
Questa pagina spiega come visualizzare e impostare l'ID della pagina.
L'ID della pagina è una stringa univoca che identifica ogni pagina del sito di documentazione. Puoi visualizzare l'ID della pagina nella barra degli indirizzi del browser quando ti trovi su una pagina specifica. L'ID della pagina viene utilizzato per l'URL, il nome del file e per creare link di riferimento incrociato.
Ad esempio, se stai visualizzando questa pagina, l'URL nella barra degli indirizzi del browser sarà simile a:
https://docs.aws.amazon.com/view-set-page-id.html
L'ultima parte dell'URL (view-set-page-id) è l'ID della pagina.
Imposta l'ID della pagina
Quando si crea una nuova pagina, è necessario impostare l'ID della pagina nel file sorgente. L'ID della pagina deve essere una stringa concisa e sillabata che descrive il contenuto della pagina.
-
Apri il file sorgente della nuova pagina in un editor di testo.
-
Nella parte superiore del file, aggiungi la riga seguente. Dovrebbe essere al di sopra del primo titolo.
[#my-new-page]Sostituiscilo
my-new-pagecon l'ID della tua nuova pagina. -
Salvare il file.
Nota
La pagina IDs deve essere unica in tutto il sito di documentazione. Se provi a utilizzare un ID di pagina esistente, riceverai un errore di compilazione.
Crea una nuova pagina
Scopri come creare una nuova pagina e aggiornare il sommario della guida.
Crea metadati di pagina
-
Determina il titolo della pagina e il titolo breve della pagina. Il titolo breve della pagina è facoltativo, ma consigliato se il titolo della pagina è composto da più di poche parole.
-
Determina l'ID della pagina. Questo deve essere unico all'interno della EKS Best Practices Guide. La convenzione prevede di utilizzare tutte le parole minuscole e separate con.
- -
Crea un nuovo file asciidoc, in una cartella se necessario, e aggiungi il seguente testo al file:
[.» argomento "] [#<page-id>] = <page-title>:info_titleabbrev: < > page-short-title
Ad esempio,
[.» topic "] [#scalability] = Migliori pratiche di scalabilità EKS:info_titleabbrev: Scalabilità
Aggiungi al sommario
-
Apri il file per la pagina principale nel sommario. Per le nuove sezioni della guida di primo livello, il file principale è
book.adoc. -
Nella parte inferiore del file principale, aggiorna e inserisci la seguente direttiva:
include: <new-filename>[leveloffset=+1]
Ad esempio,
include: :dataplane.adoc [leveloffset=+1]
Inserisci un'immagine
-
Trova il prefisso dell'immagine per la pagina che stai modificando. Controlla la
:imagesdir:proprietà nell'intestazione del file. Ad esempio,`:imagesdir: images/reliability/ -
Posiziona l'immagine in questo percorso, ad esempio
latest/bpg/images/reliability -
Determina il testo alternativo appropriato per la tua immagine. Scrivi una breve descrizione di alto livello dell'immagine. Ad esempio, «diagramma del VPC con tre zone di disponibilità» è un testo alternativo appropriato.
-
Aggiorna il seguente esempio con il testo alternativo e il nome del file di immagine. Inserite nella posizione desiderata.
immagine: <image-filename>[< image-alt-text >]
Ad esempio,
immagine: eks-data-plane-connectivity .jpeg [Diagramma di rete]
Controlla lo stile con Vale
-
Esegui
vale sync -
Installa l'estensione Vale
da Visual Studio Marketplace. -
Riavvia VS Code e apri un AsciiDoc file
-
VS Code sottolinea il testo problematico. Scopri come lavorare con errori e avvisi
nei documenti di VS Code.
Crea un'anteprima locale
-
Installa
asciidoctorlo strumento utilizzandobrewLinux o macOS-
Scopri come installare asciidoctor cli
nei documenti. AsciiDoctor -
Scopri come installare
il gestore di pacchetti brew.
-
-
Apri un terminale e vai a
latest/bpg/ -
Esegui
asciidoctor book.adoc-
Esamina eventuali avvisi ed errori di sintassi
-
-
Aprire il file di
book.htmloutput.-
Su macOS, puoi eseguire
open book.htmlper aprire l'anteprima nel tuo browser predefinito.
-
AsciiDoc Cheat Sheet
Formattazione di base
*bold text*
_italic text_
`monospace text`Headers
= Document Title (Header 1)
== Header 2
=== Header 3
==== Header 4
===== Header 5
====== Header 6Elenchi
Elenchi non ordinati:
- Item 1
- Item 2
-- Subitem 2.1
-- Subitem 2.2
- Item 3Elenchi ordinati:
. First item
. Second item
.. Subitem 2.1
.. Subitem 2.2
. Third itemLink
External link: https://example.com[Link text]
Internal link: <<page-id>>
Internal link: xref:page-id[Link text]Immagini
image::image-file.jpg[Alt text]
Blocchi di codice
[source,python]
----
def hello_world():
print("Hello, World!")
----Tabelle
Scopri come creare una tabella di base.
[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
|===Ammonizioni
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.Anteprima:
Nota
Questa è una nota di ammonimento.
Include
include::filename.adoc[]