Add Document Conventions file (#1039)

* Add Document Conventions file

Signed-off-by: Jillian <jillian.maroket@suse.com>

* Move list of limitations

Signed-off-by: Jillian <jillian.maroket@suse.com>

* Fix wording issues

Signed-off-by: Jillian <jillian.maroket@suse.com>

* Update Document Conventions file and add to all active versions

Signed-off-by: Jillian <jillian.maroket@suse.com>

* Update weight values in v1.7.x files

Signed-off-by: Jillian <jillian.maroket@suse.com>

* Update weight values in v1.6.x files

Signed-off-by: Jillian <jillian.maroket@suse.com>

* docs(crypto): v2 volume encryption support

ref: longhorn/longhorn 7355

Signed-off-by: James Lu <james.lu@suse.com>

* doc(backup): multiple backup stores support

ref: longhorn/longhorn 5411, 10043, 10089

Signed-off-by: James Lu <james.lu@suse.com>

* docs: add required kernel modules for engine v2

Signed-off-by: jangseon.ryu <jangseon.ryu@navercorp.com>

* docs: replace "preview" with "experimental"

Longhorn 9794

Signed-off-by: Derek Su <derek.su@suse.com>

* docs(v1.8.0): update important note

Signed-off-by: Derek Su <derek.su@suse.com>

* docs: add ticket links

Signed-off-by: Derek Su <derek.su@suse.com>

* doc(1.9.0): publish as dev

Signed-off-by: Chin-Ya Huang <chin-ya.huang@suse.com>

* Add Document Conventions file and apply weight value changes to v1.9.0

Signed-off-by: Jillian <jillian.maroket@suse.com>

* Update description of Dev release and remove mention of SUSE

Signed-off-by: Jillian <jillian.maroket@suse.com>

* Replace mentions of 'version' with 'release' for consistency

Signed-off-by: Jillian <jillian.maroket@suse.com>

---------

Signed-off-by: Jillian <jillian.maroket@suse.com>
Signed-off-by: James Lu <james.lu@suse.com>
Signed-off-by: jangseon.ryu <jangseon.ryu@navercorp.com>
Signed-off-by: Derek Su <derek.su@suse.com>
Signed-off-by: Chin-Ya Huang <chin-ya.huang@suse.com>
Signed-off-by: Jillian <67180770+jillian-maroket@users.noreply.github.com>
Co-authored-by: James Lu <james.lu@suse.com>
Co-authored-by: jangseon.ryu <jangseon.ryu@navercorp.com>
Co-authored-by: Derek Su <derek.su@suse.com>
Co-authored-by: Chin-Ya Huang <chin-ya.huang@suse.com>
Co-authored-by: David Ko <dko@suse.com>

content/docs/1.6.0/best-practices.md

@@ -1,6 +1,6 @@
 ---
 title: Best Practices
-weight: 5
+weight: 4
 ---
 
 We recommend the following setup for deploying Longhorn in production.

content/docs/1.6.0/concepts.md

@@ -1,6 +1,6 @@
 ---
 title: Architecture and Concepts
-weight: 3
+weight: 2
 ---
 
 Longhorn creates a dedicated storage controller for each volume and synchronously replicates the volume across multiple replicas stored on multiple nodes.

content/docs/1.6.0/document-conventions.md

@@ -0,0 +1,53 @@
+---
+title: Document Conventions
+weight: 5
+---
+
+## Release Labels
+
+Each minor release is supported until the next minor release becomes stable.
+
+- **Dev**: The software is under active development and has not been thoroughly tested. Upgrading from earlier releases or to later releases is not supported. "Dev" releases typically occur at the end of a sprint, and may occur when other definitions of done are met. Given the unofficial nature of the release, use the software only for testing purposes.
+
+- **Latest**: The software has passed all stages of verification and testing. All remaining known issues are considered acceptable. Use the software only for testing purposes.
+
+- **Stable**: The software is considered reliable and free of critical issues. This release is recommended for general use.
+
+- **EOL**: The software has reached the end of its useful life and no further code-level maintenance is provided. You may continue to use the software within the terms of the licensing agreement. Upgrading to a stable release is recommended.
+
+> **Note**:
+>
+> Longhorn provides documentation for new features, enhancements, and bug fixes implemented in major, minor, and patch releases.
+
+## Feature Labels
+
+Features that are labeled **Experimental** and **Technical Preview** provide glimpses into upcoming innovations and offer opportunities to test new technologies within your environment.
+
+- **Experimental**: The feature is incomplete but its essential functionality is operational. Tests in a controlled environment have shown that it can coexist with existing stable features. Because of the missing components and/or evolving functionality, the feature is not recommended for use in production environments.
+
+- **Technical Preview**: The feature is almost complete and its functionality is not expected to change significantly. Tests in a controlled environment have shown that it can coexist with existing stable features. Explore the feature extensively before using in production environments.
+
+These features have the following limitations:
+
+- Still in development and may be functionally incomplete, unstable, or in other ways unsuitable for production use.
+- Not supported.
+- May only be available for specific hardware architectures. Details and functionality are subject to change. As a result, upgrading to subsequent releases may be impossible and may require a fresh installation.
+- Can be removed from the product at any time. This may occur, for example, if we discover that the feature does not meet customer or market needs, or does not comply with enterprise standards.
+
+> **Note**:
+> 
+> **Experimental** and **Technical Preview** features are usually disabled by default. The documentation provides information about how you can enable and configure such features.
+
+## Admonitions
+
+Admonitions are text blocks that provide additional or important information. Each text block is marked with a special label and icon.
+
+- **Note**: Additional information that is useful but not critical.
+
+- **Important**: Information that requires special attention, such as changes in product behavior.
+
+- **Tip**: Helpful advice and suggestions, such as alternative methods of completing a task.
+
+- **Caution**: Information that must be considered before proceeding with specific actions, such as errors that may occur.
+
+- **Warning**: Critical information about harmful consequences, such as irreversible damage and data loss.

content/docs/1.6.0/terminology.md

@@ -1,6 +1,6 @@
 ---
 title: Terminology
-weight: 4
+weight: 3
 ---
 
 - [Attach/Reattach](#attachreattach)

content/docs/1.6.1/best-practices.md

@@ -1,6 +1,6 @@
 ---
 title: Best Practices
-weight: 5
+weight: 4
 ---
 
 We recommend the following setup for deploying Longhorn in production.

content/docs/1.6.1/concepts.md

@@ -1,6 +1,6 @@
 ---
 title: Architecture and Concepts
-weight: 3
+weight: 2
 ---
 
 Longhorn creates a dedicated storage controller for each volume and synchronously replicates the volume across multiple replicas stored on multiple nodes.

content/docs/1.6.1/document-conventions.md

@@ -0,0 +1,53 @@
+---
+title: Document Conventions
+weight: 5
+---
+
+## Release Labels
+
+Each minor release is supported until the next minor release becomes stable.
+
+- **Dev**: The software is under active development and has not been thoroughly tested. Upgrading from earlier releases or to later releases is not supported. "Dev" releases typically occur at the end of a sprint, and may occur when other definitions of done are met. Given the unofficial nature of the release, use the software only for testing purposes.
+
+- **Latest**: The software has passed all stages of verification and testing. All remaining known issues are considered acceptable. Use the software only for testing purposes.
+
+- **Stable**: The software is considered reliable and free of critical issues. This release is recommended for general use.
+
+- **EOL**: The software has reached the end of its useful life and no further code-level maintenance is provided. You may continue to use the software within the terms of the licensing agreement. Upgrading to a stable release is recommended.
+
+> **Note**:
+>
+> Longhorn provides documentation for new features, enhancements, and bug fixes implemented in major, minor, and patch releases.
+
+## Feature Labels
+
+Features that are labeled **Experimental** and **Technical Preview** provide glimpses into upcoming innovations and offer opportunities to test new technologies within your environment.
+
+- **Experimental**: The feature is incomplete but its essential functionality is operational. Tests in a controlled environment have shown that it can coexist with existing stable features. Because of the missing components and/or evolving functionality, the feature is not recommended for use in production environments.
+
+- **Technical Preview**: The feature is almost complete and its functionality is not expected to change significantly. Tests in a controlled environment have shown that it can coexist with existing stable features. Explore the feature extensively before using in production environments.
+
+These features have the following limitations:
+
+- Still in development and may be functionally incomplete, unstable, or in other ways unsuitable for production use.
+- Not supported.
+- May only be available for specific hardware architectures. Details and functionality are subject to change. As a result, upgrading to subsequent releases may be impossible and may require a fresh installation.
+- Can be removed from the product at any time. This may occur, for example, if we discover that the feature does not meet customer or market needs, or does not comply with enterprise standards.
+
+> **Note**:
+> 
+> **Experimental** and **Technical Preview** features are usually disabled by default. The documentation provides information about how you can enable and configure such features.
+
+## Admonitions
+
+Admonitions are text blocks that provide additional or important information. Each text block is marked with a special label and icon.
+
+- **Note**: Additional information that is useful but not critical.
+
+- **Important**: Information that requires special attention, such as changes in product behavior.
+
+- **Tip**: Helpful advice and suggestions, such as alternative methods of completing a task.
+
+- **Caution**: Information that must be considered before proceeding with specific actions, such as errors that may occur.
+
+- **Warning**: Critical information about harmful consequences, such as irreversible damage and data loss.

content/docs/1.6.1/terminology.md

@@ -1,6 +1,6 @@
 ---
 title: Terminology
-weight: 4
+weight: 3
 ---
 
 - [Attach/Reattach](#attachreattach)

content/docs/1.6.2/best-practices.md

@@ -1,6 +1,6 @@
 ---
 title: Best Practices
-weight: 5
+weight: 4
 ---
 
 We recommend the following setup for deploying Longhorn in production.

content/docs/1.6.2/concepts.md

@@ -1,6 +1,6 @@
 ---
 title: Architecture and Concepts
-weight: 3
+weight: 2
 ---
 
 Longhorn creates a dedicated storage controller for each volume and synchronously replicates the volume across multiple replicas stored on multiple nodes.

content/docs/1.6.2/document-conventions.md

@@ -0,0 +1,53 @@
+---
+title: Document Conventions
+weight: 5
+---
+
+## Release Labels
+
+Each minor release is supported until the next minor release becomes stable.
+
+- **Dev**: The software is under active development and has not been thoroughly tested. Upgrading from earlier releases or to later releases is not supported. "Dev" releases typically occur at the end of a sprint, and may occur when other definitions of done are met. Given the unofficial nature of the release, use the software only for testing purposes.
+
+- **Latest**: The software has passed all stages of verification and testing. All remaining known issues are considered acceptable. Use the software only for testing purposes.
+
+- **Stable**: The software is considered reliable and free of critical issues. This release is recommended for general use.
+
+- **EOL**: The software has reached the end of its useful life and no further code-level maintenance is provided. You may continue to use the software within the terms of the licensing agreement. Upgrading to a stable release is recommended.
+
+> **Note**:
+>
+> Longhorn provides documentation for new features, enhancements, and bug fixes implemented in major, minor, and patch releases.
+
+## Feature Labels
+
+Features that are labeled **Experimental** and **Technical Preview** provide glimpses into upcoming innovations and offer opportunities to test new technologies within your environment.
+
+- **Experimental**: The feature is incomplete but its essential functionality is operational. Tests in a controlled environment have shown that it can coexist with existing stable features. Because of the missing components and/or evolving functionality, the feature is not recommended for use in production environments.
+
+- **Technical Preview**: The feature is almost complete and its functionality is not expected to change significantly. Tests in a controlled environment have shown that it can coexist with existing stable features. Explore the feature extensively before using in production environments.
+
+These features have the following limitations:
+
+- Still in development and may be functionally incomplete, unstable, or in other ways unsuitable for production use.
+- Not supported.
+- May only be available for specific hardware architectures. Details and functionality are subject to change. As a result, upgrading to subsequent releases may be impossible and may require a fresh installation.
+- Can be removed from the product at any time. This may occur, for example, if we discover that the feature does not meet customer or market needs, or does not comply with enterprise standards.
+
+> **Note**:
+> 
+> **Experimental** and **Technical Preview** features are usually disabled by default. The documentation provides information about how you can enable and configure such features.
+
+## Admonitions
+
+Admonitions are text blocks that provide additional or important information. Each text block is marked with a special label and icon.
+
+- **Note**: Additional information that is useful but not critical.
+
+- **Important**: Information that requires special attention, such as changes in product behavior.
+
+- **Tip**: Helpful advice and suggestions, such as alternative methods of completing a task.
+
+- **Caution**: Information that must be considered before proceeding with specific actions, such as errors that may occur.
+
+- **Warning**: Critical information about harmful consequences, such as irreversible damage and data loss.

content/docs/1.6.2/terminology.md

@@ -1,6 +1,6 @@
 ---
 title: Terminology
-weight: 4
+weight: 3
 ---
 
 - [Attach/Reattach](#attachreattach)

content/docs/1.6.3/best-practices.md

@@ -1,6 +1,6 @@
 ---
 title: Best Practices
-weight: 5
+weight: 4
 ---
 
 We recommend the following setup for deploying Longhorn in production.

content/docs/1.6.3/concepts.md

@@ -1,6 +1,6 @@
 ---
 title: Architecture and Concepts
-weight: 3
+weight: 2
 ---
 
 Longhorn creates a dedicated storage controller for each volume and synchronously replicates the volume across multiple replicas stored on multiple nodes.

content/docs/1.6.3/document-conventions.md

@@ -0,0 +1,53 @@
+---
+title: Document Conventions
+weight: 5
+---
+
+## Release Labels
+
+Each minor release is supported until the next minor release becomes stable.
+
+- **Dev**: The software is under active development and has not been thoroughly tested. Upgrading from earlier releases or to later releases is not supported. "Dev" releases typically occur at the end of a sprint, and may occur when other definitions of done are met. Given the unofficial nature of the release, use the software only for testing purposes.
+
+- **Latest**: The software has passed all stages of verification and testing. All remaining known issues are considered acceptable. Use the software only for testing purposes.
+
+- **Stable**: The software is considered reliable and free of critical issues. This release is recommended for general use.
+
+- **EOL**: The software has reached the end of its useful life and no further code-level maintenance is provided. You may continue to use the software within the terms of the licensing agreement. Upgrading to a stable release is recommended.
+
+> **Note**:
+>
+> Longhorn provides documentation for new features, enhancements, and bug fixes implemented in major, minor, and patch releases.
+
+## Feature Labels
+
+Features that are labeled **Experimental** and **Technical Preview** provide glimpses into upcoming innovations and offer opportunities to test new technologies within your environment.
+
+- **Experimental**: The feature is incomplete but its essential functionality is operational. Tests in a controlled environment have shown that it can coexist with existing stable features. Because of the missing components and/or evolving functionality, the feature is not recommended for use in production environments.
+
+- **Technical Preview**: The feature is almost complete and its functionality is not expected to change significantly. Tests in a controlled environment have shown that it can coexist with existing stable features. Explore the feature extensively before using in production environments.
+
+These features have the following limitations:
+
+- Still in development and may be functionally incomplete, unstable, or in other ways unsuitable for production use.
+- Not supported.
+- May only be available for specific hardware architectures. Details and functionality are subject to change. As a result, upgrading to subsequent releases may be impossible and may require a fresh installation.
+- Can be removed from the product at any time. This may occur, for example, if we discover that the feature does not meet customer or market needs, or does not comply with enterprise standards.
+
+> **Note**:
+> 
+> **Experimental** and **Technical Preview** features are usually disabled by default. The documentation provides information about how you can enable and configure such features.
+
+## Admonitions
+
+Admonitions are text blocks that provide additional or important information. Each text block is marked with a special label and icon.
+
+- **Note**: Additional information that is useful but not critical.
+
+- **Important**: Information that requires special attention, such as changes in product behavior.
+
+- **Tip**: Helpful advice and suggestions, such as alternative methods of completing a task.
+
+- **Caution**: Information that must be considered before proceeding with specific actions, such as errors that may occur.
+
+- **Warning**: Critical information about harmful consequences, such as irreversible damage and data loss.

content/docs/1.6.3/terminology.md

@@ -1,6 +1,6 @@
 ---
 title: Terminology
-weight: 4
+weight: 3
 ---
 
 - [Attach/Reattach](#attachreattach)

content/docs/1.6.4/best-practices.md

@@ -1,6 +1,6 @@
 ---
 title: Best Practices
-weight: 5
+weight: 4
 ---
 
 We recommend the following setup for deploying Longhorn in production.

content/docs/1.6.4/concepts.md

@@ -1,6 +1,6 @@
 ---
 title: Architecture and Concepts
-weight: 3
+weight: 2
 ---
 
 Longhorn creates a dedicated storage controller for each volume and synchronously replicates the volume across multiple replicas stored on multiple nodes.

content/docs/1.6.4/document-conventions.md

@@ -0,0 +1,53 @@
+---
+title: Document Conventions
+weight: 5
+---
+
+## Release Labels
+
+Each minor release is supported until the next minor release becomes stable.
+
+- **Dev**: The software is under active development and has not been thoroughly tested. Upgrading from earlier releases or to later releases is not supported. "Dev" releases typically occur at the end of a sprint, and may occur when other definitions of done are met. Given the unofficial nature of the release, use the software only for testing purposes.
+
+- **Latest**: The software has passed all stages of verification and testing. All remaining known issues are considered acceptable. Use the software only for testing purposes.
+
+- **Stable**: The software is considered reliable and free of critical issues. This release is recommended for general use.
+
+- **EOL**: The software has reached the end of its useful life and no further code-level maintenance is provided. You may continue to use the software within the terms of the licensing agreement. Upgrading to a stable release is recommended.
+
+> **Note**:
+>
+> Longhorn provides documentation for new features, enhancements, and bug fixes implemented in major, minor, and patch releases.
+
+## Feature Labels
+
+Features that are labeled **Experimental** and **Technical Preview** provide glimpses into upcoming innovations and offer opportunities to test new technologies within your environment.
+
+- **Experimental**: The feature is incomplete but its essential functionality is operational. Tests in a controlled environment have shown that it can coexist with existing stable features. Because of the missing components and/or evolving functionality, the feature is not recommended for use in production environments.
+
+- **Technical Preview**: The feature is almost complete and its functionality is not expected to change significantly. Tests in a controlled environment have shown that it can coexist with existing stable features. Explore the feature extensively before using in production environments.
+
+These features have the following limitations:
+
+- Still in development and may be functionally incomplete, unstable, or in other ways unsuitable for production use.
+- Not supported.
+- May only be available for specific hardware architectures. Details and functionality are subject to change. As a result, upgrading to subsequent releases may be impossible and may require a fresh installation.
+- Can be removed from the product at any time. This may occur, for example, if we discover that the feature does not meet customer or market needs, or does not comply with enterprise standards.
+
+> **Note**:
+> 
+> **Experimental** and **Technical Preview** features are usually disabled by default. The documentation provides information about how you can enable and configure such features.
+
+## Admonitions
+
+Admonitions are text blocks that provide additional or important information. Each text block is marked with a special label and icon.
+
+- **Note**: Additional information that is useful but not critical.
+
+- **Important**: Information that requires special attention, such as changes in product behavior.
+
+- **Tip**: Helpful advice and suggestions, such as alternative methods of completing a task.
+
+- **Caution**: Information that must be considered before proceeding with specific actions, such as errors that may occur.
+
+- **Warning**: Critical information about harmful consequences, such as irreversible damage and data loss.

content/docs/1.6.4/terminology.md

@@ -1,6 +1,6 @@
 ---
 title: Terminology
-weight: 4
+weight: 3
 ---
 
 - [Attach/Reattach](#attachreattach)