Condividi tramite

Inizia a contribuire alla documentazione di PowerShell

  • Articolo

Questo articolo è una panoramica di come iniziare come collaboratore alla documentazione di PowerShell.

struttura PowerShell-Docs

Esistono tre categorie di contenuto nel repository PowerShell-Docs.

  • contenuto di riferimento
  • contenuto concettuale
  • file di configurazione e metadati

Contenuto di riferimento

Il contenuto di riferimento è il riferimento ai cmdlet di PowerShell per i cmdlet forniti in PowerShell. Il riferimento del cmdlet viene raccolto in cartelle versionate (come 5.1, 7.4 e 7.5), che contengono riferimenti per i moduli inclusi in PowerShell. Questo contenuto viene utilizzato anche per creare le informazioni di aiuto visualizzate dal cmdlet Get-Help.

Contenuto concettuale

La documentazione concettuale non è organizzata per versione. Tutti gli articoli vengono visualizzati per ogni versione di PowerShell.

Nota

Ogni volta che viene aggiunto, rimosso o rinominato un articolo concettuale, il sommario deve essere aggiornato e i file eliminati o rinominati devono essere reindirizzati.

File di metadati

Questo progetto contiene diversi tipi di file di metadati. I file di metadati controllano il comportamento degli strumenti di compilazione e del sistema di pubblicazione. Solo PowerShell-Docs gestori e collaboratori approvati possono modificare questi file. Se si ritiene che un meta file debba essere modificato, aprire un problema per discutere le modifiche necessarie.

Meta file nella radice del repository

  • .* : file di configurazione nella radice del repository
  • *.md - Documentazione di Project nella radice del repository
  • *.yml - Documentazione del progetto nella radice del repository
  • .devcontainer/* - File di configurazione di devcontainer
  • .github/**/* - Modelli, azioni e altri meta file di GitHub
  • .vscode/**/* - Configurazioni delle estensioni di VS Code
  • assets/* : contiene file scaricabili collegati nella documentazione
  • redir/* - contiene file di mapping di reindirizzamento
  • tests/* - Strumenti di test usati dal sistema di compilazione
  • tools/* : altri strumenti usati dal sistema di compilazione

File meta nell'insieme di documentazione

  • reference/**/*.json - File di configurazione docset
  • reference/**/*.yml - Sommario e altri file di contenuto strutturati
  • reference/bread/* - configurazione navigazione a briciole di pane
  • reference/includes/* - file di inclusione in markdown
  • reference/mapping/* - Configurazione del mapping delle versioni
  • reference/**/media/** - File di immagine usati nella documentazione
  • reference/module/* - Configurazione della pagina del browser dei moduli

Creazione di nuovi articoli

È necessario creare un'issue su GitHub per qualsiasi nuovo documento che si desidera contribuire. Verificare la presenza di problemi esistenti per assicurarsi di non duplicare gli sforzi. I problemi assegnati vengono considerati in progress. Se desideri discutere di un problema, contatta la persona assegnata al problema.

Analogamente al processo RFC di PowerShell , creare un problema prima di scrivere il contenuto. La misura garantisce di non perdere tempo e impegno sul lavoro che viene rifiutato dal team PowerShell-Docs. La questione ci consente di consultarci con voi sull'ambito del contenuto e su dove si colloca nella documentazione di PowerShell. Tutti gli articoli devono essere inclusi nel sommario (TOC). La posizione del sommario proposta dovrebbe essere inclusa nella discussione della questione.

Nota

Il sommario per il contenuto di riferimento viene generato automaticamente dal sistema di pubblicazione. Non è necessario aggiornare il sommario.

Aggiornamento di articoli esistenti

Dove applicabile, gli articoli di riferimento sui cmdlet sono duplicati in tutte le versioni di PowerShell mantenute in questo repository. Quando si segnala un problema relativo a un riferimento a un cmdlet o a un articolo di About_, elencare le versioni dell'articolo che presentano il problema.

Applicare la modifica appropriata a ogni versione del file.

Contenuto localizzato

La documentazione di PowerShell è scritta in inglese e tradotta in 17 altre lingue. Il contenuto in lingua inglese viene archiviato nel repository GitHub denominato MicrosoftDocs/PowerShell-Docs. I problemi rilevati nel contenuto tradotto devono essere inviati al repository inglese.

Tutte le traduzioni iniziano prima dal contenuto inglese. Usiamo sia la traduzione umana che quella automatica.

Metodo di traduzione Lingue
Traduzione umana de-DE, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, ru-RU, zh-CN, zh-TW
Traduzione automatica cs-CZ, hu-HU, nl-NL, pl-PL, pt-PT, sv-SE, tr-TR

Il contenuto tradotto dalla traduzione automatica potrebbe non sempre comportare scelte di parole corrette e grammatica. Se trovi un errore nella traduzione di qualsiasi lingua, invece che nei dettagli tecnici dell'articolo, segnala un problema spiegando perché ritieni che la traduzione sia sbagliata.

Alcuni problemi di traduzione possono essere risolti modificando i file di origine in inglese. Tuttavia, alcuni problemi potrebbero richiedere aggiornamenti al sistema di traduzione interno. Per questi casi, è necessario inviare il problema al team di localizzazione interno per la revisione e la risposta.

Passaggi successivi

Esistono due modi comuni per inviare modifiche in GitHub. Entrambi i metodi sono descritti nella Guida per i collaboratori centrali:

  1. È possibile apportare modifiche rapide ai documenti esistenti nell'interfaccia Web di GitHub.
  2. Usare il flusso di lavoro GitHub completo per aggiungere nuovi articoli, aggiornare più file o apportare altre modifiche importanti.

Prima di avviare le modifiche, è necessario creare un fork del repository PowerShell-Docs. Le modifiche devono essere apportate in un ramo di lavoro nella copia di PowerShell-Docs. Se si usa il metodo modifica rapida in GitHub, questi passaggi vengono gestiti automaticamente. Se stai usando il flusso di lavoro completo di GitHub , devi essere configurato per lavorare localmente.

Entrambi i metodi terminano con la creazione di un Pull Request (PR). Per altre informazioni e procedure consigliate, vedere Invio di una richiesta pull.