Aan de slag bijdragen aan PowerShell-documentatie

Dit artikel bevat een overzicht van hoe u als inzender aan de slag kunt gaan met PowerShell-documentatie.

PowerShell-Docs structuur

De PowerShell-Docs-opslagplaats is onderverdeeld in twee groepen inhoud: verwijzing en conceptueel.

Referentie-inhoud

De referentie-inhoud is de PowerShell-cmdlet-referentie voor de cmdlets die worden verzonden in PowerShell. De verwijzing wordt verzameld in versiesmappen (5.1, 7.0, 7.1 en 7.2). Deze inhoud bevat alleen cmdlet-verwijzing voor de modules die worden verzonden met PowerShell. Deze inhoud wordt ook gebruikt om de Help-informatie te maken die wordt weergegeven door de Get-Help cmdlet.

Conceptuele inhoud

De conceptuele documentatie bevat de volgende inhoud:

  • Opmerkingen bij de release
  • Installatie-instructies
  • Voorbeeldscripts en artikelen met procedures
  • DSC-documentatie
  • SDK-documentatie

De conceptuele documentatie is niet ingedeeld op versie. Alle artikelen worden weergegeven voor elke versie van PowerShell. We werken aan het maken van versiespecifieke artikelen.

Notitie

Wanneer een conceptueel artikel wordt toegevoegd, verwijderd of hernoemd, moet de inhoudsaanvraag worden bijgewerkt en opgenomen in de pull-aanvraag.

Nieuwe artikelen maken

Er moet een GitHub probleem worden gemaakt voor elk nieuw document dat u wilt bijdragen. Controleer op bestaande problemen om ervoor te zorgen dat u geen pogingen dupliceert. Toegewezen problemen worden beschouwd als in progress. Als u wilt samenwerken aan een probleem, neemt u contact op met de persoon die aan het probleem is toegewezen.

Net als bij het RFC-proces van PowerShell maakt u een probleem voordat u de inhoud schrijft. Het probleem zorgt ervoor dat u geen tijd en moeite verspilt aan werk dat wordt geweigerd door het PowerShell-Docs team. Het probleem stelt ons in staat om met u te overleggen over het bereik van de inhoud en waar het in de PowerShell-documentatie past. Alle artikelen moeten worden opgenomen in de inhoudsopgave ( Inhoudsopgave). De voorgestelde locatie van de toc moet worden opgenomen in de discussie over het probleem.

Notitie

De inhoudsopgave voor referentie-inhoud wordt automatisch gegenereerd door het publicatiesysteem. U hoeft de toc niet bij te werken.

Bestaande artikelen bijwerken

Waar van toepassing worden naslagartikelen voor cmdlets gedupliceerd in alle versies van PowerShell die in deze opslagplaats worden onderhouden. Wanneer u een probleem meldt over een cmdlet-verwijzing of een About_ artikel, moet u opgeven welke versies worden beïnvloed door het probleem. De probleemsjabloon in GitHub bevat een controlelijst met versies. Gebruik de selectievakjes om op te geven welke versies van de inhoud worden beïnvloed.

Controleer alle versies van het artikel om te zien of dezelfde wijziging nodig is in de andere versies. Pas de juiste wijziging toe op elke versie van het bestand.

Gelokaliseerde inhoud

De PowerShell-documentatie is geschreven in het Engels en vertaald in 17 andere talen. De Engelse inhoud wordt opgeslagen in de GitHub opslagplaats met de naam MicrosoftDocs/PowerShell-Docs. De gelokaliseerde inhoud wordt voor elke taal opgeslagen in een afzonderlijke opslagplaats. De opslagplaatsen gebruiken dezelfde basisnaam, maar voegen de landinstellingsnaam toe aan het einde. Bevat bijvoorbeeld MicrosoftDocs/PowerShell-Docs.de-de de inhoud die is vertaald naar het Duits.

Over het algemeen moeten problemen en wijzigingen worden ingediend bij de Engelse opslagplaats. Alle vertalingen beginnen eerst vanaf de Engelse inhoud. We gebruiken zowel menselijke als machinevertaling.

Vertaalmethode Talen
Menselijke vertaling de-DE, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, ru-RU, zh-CN, zh-TW
Automatische vertaling cs-CZ, hu-HU, nl-NL, pl-PL, pt-PT, sv-SE, tr-TR

De inhoud die door automatische vertaling wordt vertaald, kan niet altijd resulteren in juiste woordkeuzen en grammatica. Als u een fout in vertaling vindt voor elke taal, in plaats van in de technische details van het artikel, opent u een probleem in de gelokaliseerde opslagplaats. Leg uit waarom u denkt dat de vertaling onjuist is. Ons lokalisatieteam beoordeelt en reageert op deze problemen.

Volgende stappen

Er zijn twee algemene manieren om wijzigingen in GitHub in te dienen. Beide methoden worden beschreven in de centrale gids voor inzenders:

  1. U kunt snel wijzigingen aanbrengen in bestaande documenten in de GitHub webinterface.
  2. Gebruik de volledige GitHub werkstroom voor het toevoegen van nieuwe artikelen, het bijwerken van meerdere bestanden of andere grote wijzigingen.

Voordat u wijzigingen start, moet u een fork van de PowerShell-Docs opslagplaats maken. De wijzigingen moeten worden aangebracht in een werkvertakking in uw kopie van de PowerShell-Docs. Als u de methode voor snelle bewerking in GitHub gebruikt, worden deze stappen voor u afgehandeld. Als u de volledige GitHub werkstroom gebruikt, moet u zijn ingesteld om lokaal te kunnen werken.

Beide methoden eindigen met het maken van een pull-aanvraag (PR). Zie Een pull-aanvraag indienen voor meer informatie en aanbevolen procedures.