Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added a note reg. new documentation page #208

Merged
merged 2 commits into from
May 2, 2024

Conversation

balaharish7
Copy link
Contributor

No description provided.

README.md Outdated
@@ -10,6 +10,10 @@ It is provided here as a convenience to the writers, reviewers and editors of Ma
The official Mayastor User Reference for the latest GA release can be found [here](https://mayastor.gitbook.io/)
{% endhint %}

{% hint style="danger" %}
This is not the latest version of the documentation. Refer to the [OpenEBS Documentation](https://openebs.io/docs) to view the latest documentation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we point to the replicated engine overview link?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this message, we also need to specify that Mayastor documentation till version 2.5 are published on this website. For versions 2.6 and above, refer to the openebs docs with the link..

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we point to the replicated engine overview link?

@avishnu We can do that, but it will point out to the Installation page of Mayastor as it's the 1st page in the Replicated Engine folder.

So kindly suggest, if we can still point out to that or can we point to the Introduction to OpenEBS page?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we say
Mayastor is now known as OpenEBS Replicated Storage and that the Mayastor latest documentation (v2.6 and above) are now published as part of OpenEBS documentation?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've rephrased it slightly as:

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.

README.md Outdated
@@ -10,6 +10,10 @@ It is provided here as a convenience to the writers, reviewers and editors of Ma
The official Mayastor User Reference for the latest GA release can be found [here](https://mayastor.gitbook.io/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this line

@avishnu avishnu merged commit dbbec5f into openebs:develop May 2, 2024
2 checks passed
balaharish7 added a commit that referenced this pull request May 7, 2024
* docs: added a note reg. new documentation page

Signed-off-by: Bala Harish <[email protected]>

* docs: tweaked the instructions as per the comments

Signed-off-by: Bala Harish <[email protected]>

---------

Signed-off-by: Bala Harish <[email protected]>
avishnu pushed a commit that referenced this pull request May 7, 2024
* docs: added a note reg. new documentation page



* docs: tweaked the instructions as per the comments



---------

Signed-off-by: Bala Harish <[email protected]>
Abhinandan-Purkait pushed a commit that referenced this pull request May 8, 2024
* docs: added a note reg. new documentation page

Signed-off-by: Bala Harish <[email protected]>

* docs: tweaked the instructions as per the comments

Signed-off-by: Bala Harish <[email protected]>

---------

Signed-off-by: Bala Harish <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants