參與GitHub的NetApp技術內容
NetApp產品與服務的文件為開放原始碼。如此一來、您就能透過改善、修正及建議、對內容做出貢獻。您只需要一個GitHub帳戶和一個小計畫。
總覽
您可以使用下列選項來貢獻我們的文件:
-
選取 * 要求文件變更 * 以提交一般意見反應、或是詢問有關內容的問題。接著、NetApp內容主管會審查您的申請、以判斷文件需要做哪些變更。這是最常見的選項。
-
選擇 * 編輯此頁面 * 可直接自行編輯內容。NetApp內容主管接著會審查您的編輯內容、並加以合併。
下列影片提供這兩個選項的簡短概觀。
以下各節提供逐步說明。
申請文件變更
提交文件變更申請是提供NetApp文件的最常見方法。提交申請後、內容主管將確認他們已收到您的意見反應。您會在收到GitHub的電子郵件通知後收到通知。
如果內容主管同意您的建議可以讓內容更好、他們會在稍後提交變更。您將會收到另一則通知、告知您的意見已納入其中。
您提供的所有意見都會公開顯示。任何瀏覽GitHub repo問題的人、都能看到您的意見。 |
-
如果您還沒有GitHub帳戶、 "從github.com建立一個"
-
登入GitHub帳戶。
-
使用網頁瀏覽器、開啟上的頁面 "docs.netapp.com" 這與您的意見反應有關。
-
在頁面頂端、選取 * 建議變更 > 要求文件變更 * 。
新的瀏覽器索引標籤隨即開啟、其中含有 GitHub 表單、您可以使用此表單來提供文件團隊的詳細資料。
-
輸入標題、摘要、並確認問題不包含任何敏感資訊。
表單會預先填入頁面的 URL 和標題。請勿刪除此資訊、因為我們需要它來瞭解您的要求。
-
選擇 * 提交新問題 * 、為您的申請建立問題。
開啟問題可透過GitHub意見進行協同作業。您將會根據GitHub帳戶設定中的偏好設定收到電子郵件通知。
您也可以從 GitHub 橫幅選取 * 問題 * 來檢視申請狀態:
提交對文件的編輯
如果您願意自行編輯內容、可以直接編輯來源檔案、提交您想要查看的確切文件變更。
身為外部參與者、您將無法直接發佈變更。內容主管將審查變更、進行任何必要的編輯、然後合併變更。發生這種情況時、您會收到GitHub的電子郵件通知。
如果您需要我們撰寫樣式或來源語法的協助、可以使用下列資源:
-
如果您還沒有GitHub帳戶、 "從github.com建立一個"
-
登入GitHub帳戶。
-
使用網頁瀏覽器、開啟上的頁面 "docs.netapp.com" 您想要編輯的。
-
在頁面頂端、選取 * 建議變更 > 編輯此頁面 * 。
隨即開啟新的瀏覽器索引標籤、並將您帶到 GitHub 儲存庫中的文件、以供文件網站使用。
-
選取鉛筆圖示。
-
如果系統提示您建立儲存庫的分叉、請選取 * 儲存庫 * 。
-
編輯內容。
內容以輕量標記語言AsciDoc撰寫。 "瞭解 AsciDoc 語法"。
-
若要提交變更、請選取 * 提交變更 * 、然後填寫表單:
-
(可選)修改默認提交消息。
-
新增選用說明。
-
選擇 * 提議變更 * 。
-
-
選取 * 建立拉出要求 * 。
在您提出變更建議之後、我們將會進行審查、進行必要的編輯、然後將變更合併到GitHub儲存庫。
您可以從 GitHub 橫幅中選取 * 拉出要求 * 來檢視拉出要求的狀態: