文件慣例
發行類型 (Release Types)
「社群 (Community)」和「Prime」這兩個詞彙是用來區分針對社群使用者和 SUSE 客戶的發行版本。「Prime」指的是 SUSE Rancher Prime,即 SUSE 的企業級容器管理平台。
| 發行類型 | 版本命名慣例 | 範例 | 支援生命週期 |
|---|---|---|---|
| Community (社群版) | x.y.z | v1.5.0 | 每個社群版本的支援將在版本 x.(y+1).1 發佈時結束。 |
| Prime (Prime 版) | x.y.[1-z] | v1.5.1 | Prime 版本享有 6 個月的主動支援 (active support)。隨後是 12 個月的維護支援 (maintenance support),涵蓋關鍵的安全性相關問題。 |
發行標籤 (Release Labels)
Harvester 文件使用以下標籤來描述軟體的發行狀態。
-
Dev (開發版):軟體正處於活躍開發階段,尚未經過徹底測試。不支援從較早版本升級或升級至較新版本。
-
Latest (最新版):軟體已通過所有驗證和測試階段。所有剩餘的已知問題均被視為可接受。
-
EOL (終止支援):軟體已達到其產品壽命的終點,不再提供程式碼層級的維護。您可以在授權合約的條款內繼續使用該軟體。
功能標籤 (Feature Labels)
標記為 Experimental (實驗性) 和 Technical Preview (技術預覽) 的功能讓您可以預覽即將推出的創新,並提供在您的環境中測試新技術的機會。
-
Experimental (實驗性):該功能尚未完整,但其基本功能已可運作。在受控環境中的測試顯示它可以與現有的穩定功能共存。由於缺少元件及/或功能仍在演進中,不建議在生產環境中使用此功能。
-
Technical Preview (技術預覽):該功能幾乎已完成,其功能預計不會有重大變更。在受控環境中的測試顯示它可以與現有的穩定功能共存。在生產環境中使用前,請廣泛地探索此功能。
這些功能有以下限制:
- 仍在開發中,可能功能不完整、不穩定,或在其他方面不適合生產用途。
- 不提供支援。
- 可能僅適用於特定的硬體架構。詳細資訊和功能可能會變更。因此,可能無法升級到後續版本,而需要全新安裝。
- 隨時可能從產品中移除。例如,如果我們發現該功能不符合客戶或市場需求,或不符合企業標準,就可能會發生這種情況。
實驗性 和 技術預覽 功能通常預設為停用。文件會提供有關如何啟用和設定這些功能的資訊。
提示區塊 (Admonitions)
提示區塊是提供額外或重要資訊的文字區塊。每個文字區塊都標有特殊的標籤和圖示。Harvester 文件使用以下慣例來幫助您解讀資訊。
-
Note (備註):有用但非關鍵的額外資訊。
-
Important (重要):需要特別注意的資訊,例如產品行為的變更。
-
Tip (提示):有幫助的建議和訣竅,例如完成任務的替代方法。
-
Caution (注意):在進行特定操作前必須考慮的資訊,例如可能发生的錯誤。
-
Warning (警告):關於有害後果的關鍵資訊,例如不可逆的損壞和資料遺失。