本文是關於如何開始成為 PowerShell 文件的貢獻者的概覽。
PowerShell-Docs 結構
PowerShell-Docs 存放庫中有三種內容類別:
- 參考內容
- 概念性內容
- 元數據和組態檔
參考內容
參考內容是 PowerShell 中隨附 Cmdlet 的參考文件。
Cmdlet 參考 被收集在版本化的資料夾中(如 5.1、7.4、7.5 和 7.6),這些資料夾包含隨 PowerShell 提供的模組參考。 此內容也可用來建立 Get-Help Cmdlet 所顯示的說明資訊。
概念性內容
概念文件 不是依版本組織。 所有文章都會針對每個版本的 PowerShell 顯示。
備註
每當新增、移除或重新命名概念性文章時,都必須更新 TOC。 任何已刪除或重新命名的檔案都必須重新導向。
元數據檔案
此專案包含數種類型的元數據檔。 元數據檔案會控制建置工具和發佈系統的行為。 只允許 PowerShell-Docs 維護人員和核准的參與者變更這些檔案。 如果您認為應該變更中繼檔案,請開啟問題來討論所需的變更。
資料庫根目錄中的中繼檔案
-
.*- 存放庫根目錄中的組態檔 -
*.md- 存放庫的根目錄中的專案文件 -
*.yml- 存放庫的根目錄中的專案文件 -
.devcontainer/*- devcontainer 組態檔 -
.github/**/*- GitHub 範本、動作和其他中繼檔案 -
.vscode/**/*- VS Code 擴充功能組態 -
assets/*- 包含文件中連結的可下載檔案 -
redir/*- 包含重新導向對應檔案 -
tests/*- 建置系統所使用的測試工具 -
tools/*- 建置系統所使用的其他工具
文件集中的中繼檔案
-
reference/**/*.json- docset 組態檔 -
reference/**/*.yml- TOC 和其他結構化內容檔案 -
reference/bread/*- 階層鏈接瀏覽設定 -
reference/includes/*- Markdown 包含檔案 -
reference/mapping/*- 版本對應設定 -
reference/**/media/**- 用於文件中的影像檔案 -
reference/module/*- 模組瀏覽器頁面設定
建立新文章
您必須為您想要貢獻的任何新檔案建立 GitHub 議題。 檢查是否有現有的問題,以避免重複工作。 指派的問題被視為 in progress。 如果您想要在問題上共同作業,請連絡指派給問題的人員。
類似於 PowerShell RFC 程式,請在撰寫內容之前建立問題。 此問題可確保您不會浪費時間和精力來處理 PowerShell-Docs 小組拒絕的工作。 此問題使我們能與您商討內容的範圍,以及它在 PowerShell 文件中的適當位置。 所有文章都必須包含在目錄 (TOC) 中。 建議的 TOC 位置應該包含在問題討論中。
備註
發佈系統會自動產生 TOC 的參考內容。 您不需要更新 TOC。
更新現有的文章
如果適用,Cmdlet 參考文章會在此存放庫中維護的所有 PowerShell 版本之間複製。 當回報有關 Cmdlet 參考或 About_ 文章的問題時,請列出有問題的文章版本。
將適當的變更套用至檔案的每個版本。
本地化內容
PowerShell 檔是以英文撰寫,並翻譯成 17 種語言。 英文內容會儲存在名為 MicrosoftDocs/PowerShell-Docs的 GitHub 存放庫中。 翻譯內容中發現的問題應該提交至此存放庫。
所有翻譯都是先從英文內容開始。 我們同時使用人力和機器翻譯。
| 翻譯方法 | 語言 |
|---|---|
| 人工翻譯 | de-DE、es-ES、fr-FR、it-IT、ja-JP、ko-KR、pt-BR、ru-RU、zh-CN、zh-TW |
| 機器翻譯 | cs-CZ、hu-HU、nl-NL、pl-PL、pt-PT、sv-SE、tr-TR |
機器翻譯所翻譯的內容不一定會導致正確的字組選擇和文法。 如果您在任何語言的翻譯中發現錯誤,而非在文章的技術細節中發現,請開立問題,說明您為何認為翻譯錯誤。
您可以藉由變更英文來源檔案來修正某些翻譯問題。 不過,有些問題可能需要更新我們的內部翻譯系統。 針對這些情況,我們必須將問題提交至內部當地語系化小組,以檢閱和回應。
後續步驟
在 GitHub 中提交變更有兩種常見方式。 這兩種方法都會在中央參與者指南中說明:
- 您可以在 GitHub 網頁介面中 對現有文件 進行快速編輯。
- 使用 完整的 GitHub 工作流程 來新增文章、更新多個檔案或其他大型變更。
開始任何變更之前,您應該建立 PowerShell-Docs 存放庫的分支。 變更應該在PowerShell-Docs 複本的工作分支中進行。如果您在 GitHub 中使用 快速編輯 方法,則會為您處理這些步驟。 如果您使用 完整的 GitHub 工作流程,則必須設定為 在本機工作。
這兩種方法都以建立拉取請求(PR)結尾。 如需詳細資訊和最佳做法,請參閱 提交提取要求。