我們的 PowerShell 文件體驗已獲更新

這篇貼文的作者是 Azure 成長與生態系統小組經理 Jeff Sandquist

今天,我們已針對docs.microsoft.com 推出已修改的Azure PowerShell體驗。 這項體驗的增強功能包括模組版本設定、程式碼語法反白顯示、更容易巡覽的目錄,以及編輯和改善文件等功能。 我們從客戶的意見反應了解 PowerShell 內容有改善的空間,而這是我們邁向提升內容品質的下一步。 我們已從 Azure 開始進行,但在未來幾個月才會將所有 PowerShell 內容移至此項體驗。

統一的 PowerShell 模組參考

PowerShell 模組參考文件的目標是為所有在 Microsoft 出貨的 PowerShell 模組提供整合的體驗。 這包括:

  • 一致的 URL 模式 - 如果您知道模組或其 Cmdlet 的名稱,就可知道 URL。 我們在 Docs 使用的 URL 模式為:docs.microsoft.com/powershell/module/{模組名稱}/{cmdlet 名稱}/。 對於 AzureRM.Storage 模組中的 Get-AzureRMStorageAccount Cmdlet,URL 為:https://docs.microsoft.com/powershell/module/azurerm.storage/get-azurermstorageaccount
  • 一致的使用者體驗 - 模組、Cmdlet 和範例的格式現在於整個 PowerShell 文件體驗皆相同。
  • 簡易貢獻 - PowerShell 使用者可直接在文件頁面上按一下 [編輯] 按鈕,即可新增程式碼範例或編輯我們的參考文件。
  • PowerShell 先前版本的版本控制支援 - 若要篩選特定版本的 Azure PowerShell,請使用我們的頁面版本選擇器。

PowerShell 版本控制

關於特定模組的版本設定,有些模組會作為一組其他模組出貨,而各模組都有各自的個別版本設定配置。 例如,客戶透過 PowerShellGet 下載 Azure PowerShell。 以往客戶必須手動破解套用到其安裝的文件版本。 例如,如果您安裝了 Azure PowerShell 3.7,就必須知道 AzureRM 3.7 隨附 AzureRM.Automation 2.7 及 AzureRM.CognitiveServices v0.5.0 的個別模組版本,並尋找那些文件。

有了全新體驗,您要選擇的就只有一個版本,而我們會依據您所安裝的項目篩選正確模組。

PowerShell 版本選取

改善的目錄

除了 Cmdlet 參考外,我們還新增了概觀內容、安裝步驟、使用者入門及範例。 對於 Azure 參考,我們也根據 Azure 服務將 Cmdlet 分組。

顯示概觀、範例、參考的目錄

鍵入時即從目錄輕鬆篩選

您可於鍵入相符 Cmdlet 或符合該名稱的服務時,輕鬆篩選左方的目錄。

輸入時的結果篩選

Cmdlet 頁面改進

改進色彩標示及格式設定

PowerShell Cmdlet 現在經過妥善色彩標示及格式設定,閱讀效果更佳。

色彩化 PowerShell 語法

參數改進

我們先前依參數為必要或選擇性來將其分組,但參數清單看起來未經排序。 因此,我們改為新增區段標題,將必要參數和選擇性參數分組,並改善參數名稱顏色標示/樣式。

將必要和選擇性參數分組

更智慧的複製/貼上行為

我們有些 PowerShell Cmdlet 程式碼範例前面會加上 PS C:\> 字樣。 現在當您按一下程式碼範例的 [複製] 按鈕時,我們會刪去 PS C:\> 前置詞,如下方「記事本」螢幕擷取畫面所示。

複製按鈕移除文字

您的意見反應

我們希望您覺得此版本有大幅改善。