在瀏覽器中編輯文件發行項

  • 5 分鐘

既然您已概略了解一般工具以及在貢獻幕後的推動組件，讓我們看看對 Microsoft 文件做出次要貢獻的特定步驟。 當您想要對發行項進行小變更時，請先確定您已設定適當的工具。 然後，您已準備好開始編輯並且與 Microsoft Learn 社群的其他成員分享您的知識。

步驟 1：設定您的 GitHub 帳戶

因為 Microsoft Learn 整合 GitHub 工作流程來更新內容，因此您需要 GitHub 帳戶才能參與。 如果您已經有 GitHub 帳戶，請確定您已登入。

如果您還沒有 GitHub 帳戶，請使用下列步驟來建立一個帳戶：

  1. 瀏覽至 GitHub。
  2. 選取 [註冊]。
  3. 遵循提示設定帳戶。

步驟 2：進行變更

請記住，並非所有 Microsoft Learn 內容都會儲存在公用存放庫中。 進行任何變更之前，請先檢查您想要貢獻的內容是否可以公開貢獻。 如果是的話，您可以直接在瀏覽器中進行變更。

  1. 瀏覽至您想要編輯之 learn.microsoft.com 的文件發行項。 尋找發行項頂端的鉛筆形狀 [編輯] 圖示，檢查發行項是否儲存在公用存放庫中。 如果您看到圖示，則符合公開貢獻資格！

  2. 選取 [編輯] 鉛筆圖示。 這會帶您前往發行項儲存所在的公用 GitHub 存放庫中的來源檔案。

    Microsoft Learn 文件文章的螢幕擷取畫面，其中醒目提示了鉛筆編輯圖示。

  3. 選取 GitHub 檔案頁面頂端的鉛筆圖示。 此圖示標示為 [在您的此專案分支中編輯此檔案] 或 [分支此存放庫並且編輯檔案]，取決於您是否已分支檔案儲存所在的存放庫。

    此時您必須登入 GitHub 帳戶，才能選取此圖示。 如果您未登入，則無法使用此選項。

    文件文章的 GitHub 來源檔案的螢幕擷取畫面。醒目提示了編輯檔案鉛筆圖示。

    在文章頂端，您會注意到文章的中繼資料。 中繼資料會套用至發行項以進行報告、透過搜尋獲得發現性，及推動網站體驗的各個層面。 如果您要對已發佈的文章進行次要更新，您可能不需要變更中繼資料。

  4. 如果這是您第一次在此存放庫中工作，系統會提示您在提出變更之前分支存放庫。 如果是的話，請選取 [分支此存放庫]。

  5. 您會在瀏覽器中看到編輯介面或 [編輯] 窗格。 您可以看到以 Markdown 撰寫的發行項，這是格式化語法。 在窗格中進行變更。

    瀏覽器的螢幕擷取畫面，其中包含以 Markdown 語法撰寫的文件文章，其可在 [編輯] 窗格中進行編輯。

  6. 在編輯窗格頂端，選取 [預覽] 索引標籤。這可讓您藉由在已發佈表單中檢視變更來驗證變更。

步驟 3：建立您的提取要求

當您完成變更並預覽時，是時候建立提取要求 (PR) 了。 請記住，PR 是建議將變更合併至即時存放庫的主分支，以在 Microsoft Learn 上可見的方式。 PR 可藉由要求從工作分支提取變更並合併到另一個分支，來啟用 GitHub 的共同作業模型。 在大部分情況下，這個其他分支是主要存放庫中的預設分支。

  1. 尋找並選取 [認可變更] 或 [建議變更] 按鈕，通常位於頁面頂端。

  2. 新增 [認可訊息]。 這會成為 PR 的標題。 認可訊息應該是變更的簡短摘要。 您可以選擇性地新增擴充描述，以提供變更的進一步詳細資料。

    彈出方塊的螢幕擷取畫面，其中包含兩個欄位，用於建立提交訊息及新增變更的延伸描述。

  3. 選取 [建議變更]。

  4. 下一頁會要求您確認合併變更的位置，稱為基底。 確認基底是 main。

    參與者應驗證目的地存放庫和他們想要將變更合併到其中的分支的網頁螢幕擷取畫面。主分支已選為基準分支。

  5. 選取 [建立提取要求]。

  6. 預覽 PR。 對標題或描述欄位進行任何變更。

  7. 選取 [建立提取要求] 按鈕。 這會開啟您的提取要求。

您的 PR 已建立，但是尚未提交。 在下一個步驟中，您將會完成 PR 的最終驗證步驟以便合併。

案例：編輯 Azure Apps Service 發行項

回想一下，您是具備 Azure App Service 專業知識的軟體工程師。 檢閱有關 App Service 的文件文章時，您會注意到想要新增的詳細資料，以協助其他人使用該服務。 您決定藉由對 Microsoft Learn 做出第一個貢獻來分享您的知識！ 登入 GitHub 帳戶之後，您會開始貢獻程序：