Skip to content

Commit

Permalink
docs: added a note reg. new documentation page (#208) (#209)
Browse files Browse the repository at this point in the history
* docs: added a note reg. new documentation page



* docs: tweaked the instructions as per the comments



---------

Signed-off-by: Bala Harish <[email protected]>
  • Loading branch information
balaharish7 authored May 7, 2024
1 parent 16a3ac5 commit 72b001d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ description: 'The native NVMe-oF CAS engine of OpenEBS'

# Welcome to Mayastor!

{% hint style="danger" %}
### This documentation is staged on an unstable branch
It is provided here as a convenience to the writers, reviewers and editors of Mayastor's user documentation, to provide easy visualisation of content before publishing. It MUST NOT be used to guide the installation or use of Mayastor, other than for pre-release testing outside of production. As a staging branch, it is expected at times to contain errors and to be incomplete.
{% endhint %}

{% hint style="danger" %}
This is not the latest version of the documentation. Mayastor documentation up to version 2.5 is available on this website.
Mayastor is now referred to as OpenEBS Replicated Storage. The latest Mayastor documentation (v2.6 and above) is published as part of [OpenEBS Documentation](https://openebs.io/docs).
{% endhint %}

## What is Mayastor?

**Mayastor** is a performance optimised "Container Attached Storage" (CAS) solution of the CNCF project [**OpenEBS**](https://openebs.io/). The goal of OpenEBS is to extend Kubernetes with a declarative data plane, providing flexible persistent storage for stateful applications.
Expand Down

0 comments on commit 72b001d

Please sign in to comment.