Delen via


Updates voor onze PowerShell-documentatie-ervaring

Dit bericht is geschreven door Jeff Sandquist, General Manager in het Azure Growth and Ecosystem-team.

Vandaag hebben we onze vernieuwde Azure PowerShell-ervaring voor docs.microsoft.comgelanceerd. Verbeteringen in deze ervaring zijn moduleversiebeheer, markering van codesyntaxis, eenvoudiger te navigeren inhoudsopgave, de mogelijkheid om documenten te bewerken en te verbeteren, en meer. We weten van feedback van klanten dat PowerShell-inhoud een verbeteringsgebied is geweest en dit is de volgende stap in ons traject om de kwaliteit van onze inhoud te verbeteren. We zijn begonnen met Azure, maar verplaatsen al onze PowerShell-inhoud naar deze ervaring in de komende maanden.

Naslaginformatie over unified PowerShell-modules

Het doel van onze PowerShell Module-referentiedocumenten is om een uniforme ervaring te bieden voor alle PowerShell-modules die bij Microsoft worden geleverd. Dit omvat:

  • consistente URL-patronen: als u de naam van de module of een cmdlet kent, kent u de URL. Het URL-patroon dat we op Docs gebruiken, is: docs.microsoft.com/powershell/module/{module-name}/{cmdlet-name}/. Voor de Cmdlet Get-AzureRMStorageAccount die zich in de module AzureRM.Storage bevindt, is de URL: /powershell/module/azurerm.storage/get-azurermstorageaccount
  • Consistente gebruikerservaring: opmaak voor modules, cmdlets en voorbeelden is nu hetzelfde in de volledige PowerShell-documentatie.
  • Easy-bijdragen - PowerShell-gebruikers kunnen codevoorbeelden toevoegen of onze referentiedocumenten bewerken door rechtstreeks op de documentpagina op de knop Bewerken te klikken.
  • Ondersteuning voor versiebeheer voor eerdere versies van PowerShell: als u wilt filteren op een specifieke versie van Azure PowerShell, gebruikt u onze versiekiezer op de pagina.

PowerShell-versiebeheer

Hoewel we versiebeheer voor een specifieke module hebben genoemd, worden sommige modules geleverd als een groep andere modules, elk met hun eigen afzonderlijke versiebeheerschema. Klanten downloaden bijvoorbeeld Azure PowerShell via PowerShellGet. In het verleden moesten klanten handmatig ontcijferen welke versies van de documenten van toepassing zijn op hun installatie. Als u bijvoorbeeld Azure PowerShell 3.7 hebt geïnstalleerd, moet u elke afzonderlijke module weten die AzureRM 3.7 met AzureRM.Automation 2.7 en AzureRM.CognitiveServices v0.5.0 verzendt en deze documenten zoekt.

Met onze nieuwe ervaring hebt u slechts één versie die u kunt kiezen en filteren we de juiste modules op basis van wat u hebt geïnstalleerd.

Schermopname van het browservenster van Microsoft Azure, waarin de vervolgkeuzelijst Versiebeheer wordt weergegeven om een Power Shell-versie te selecteren.

Verbeterde inhoudsopgave

Naast naslaginformatie over cmdlets hebben we overzichtsinhoud, installatiestappen, aan de slag en voorbeelden toegevoegd. Ter referentie van Azure hebben we ook cmdlets gegroepeerd op basis van Azure Service.

Schermopname van het browservenster van Microsoft Azure, waarin de inhoudsopgave en het filterveld worden weergegeven.

Eenvoudig filteren terwijl u typt - uit de inhoudsopgave

U kunt de linker-inhoudsafgave eenvoudig filteren terwijl u typt voor overeenkomende cmdlets of services die overeenkomen met die naam.

GIF-animatie van het browservenster van Microsoft Azure, waarin de gebruiker de T O C filtert, wordt weergegeven door het filterveld te typen.

Verbeteringen aan cmdlet-pagina

Verbeterde kleuren en opmaak

PowerShell-cmdlets zijn nu mooi gekleurd en opgemaakt voor een betere leesbaarheid.

Schermopname van een Power Shell-opdracht die het nieuwe kleurenschema en het opmaaksysteem laat zien.

Parameterverbeteringen

Hoewel we eerder parameters groepeerden door te bepalen of ze vereist of optioneel waren, leek de lijst met parameters ongeordeerd. In plaats daarvan hebben we sectiekoppen toegevoegd om vereiste parameters en optionele parameters te groeperen en de kleur-/stijl voor parameternamen te verbeteren.

Schermopname van de parameterlijsten die worden weergegeven in Azure-artikelen, sectiekoppen weergeven en een nieuw kleurenschema weergeven.

Slimmer gedrag van kopiëren/plakken

Een aantal codevoorbeelden voor PowerShell-cmdlets wordt voorafgegaan door de tekst PS C:\>. Wanneer u op de knop Kopiëren voor het codevoorbeeld klikt, wordt het PS C:\> voorvoegsel verwijderd, zoals wordt weergegeven in de onderstaande schermafbeelding van Kladblok.

Schermafbeeldingen van de Power Shell-opdracht let en Kladblok, waarin wordt weergegeven dat de gebruiker kan kopiëren en plakken vanuit de opdracht let in Kladblok.

Uw feedback

We hopen dat u belangrijke verbeteringen in deze release ziet.