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

[doc] Add redis-cluster help document #2073

Closed
wants to merge 1 commit into from

Conversation

zzzk1
Copy link

@zzzk1 zzzk1 commented Jun 8, 2024

What's changed?

add redis cluster help document.

Checklist

  • I have read the Contributing Guide
  • I have written the necessary doc or comment.
  • I have added the necessary unit tests and all cases have passed.

Add or update API

  • I have added the necessary e2e tests and all cases have passed.

@github-actions github-actions bot added the doc Improvements or additions to documentation label Jun 8, 2024
@zzzk1
Copy link
Author

zzzk1 commented Jun 8, 2024

@tomsun28 pls take a look~

@tomsun28 tomsun28 added the good first pull request Good for newcomers label Jun 8, 2024
@zzzk1 zzzk1 force-pushed the help-doc-for-redis-cluster branch from 080f349 to 7fc3996 Compare June 9, 2024 05:21
Comment on lines +149 to +153
![](img/docs/help/redis-cluster-add.png)

final effect.

![](img/docs/help/redis-cluster-view.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

The image path is incorrect and needs to be changed to /img/docs/help/xxx

@@ -0,0 +1,157 @@
### Pre-monitoring operations
Copy link
Contributor

Choose a reason for hiding this comment

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

Here need to add a file header in first line ,like this:

---
id: redis_cluster
title: Monitoring Redis Cluster
sidebar_label: Redis Cluster Monitor
keywords: [ open source monitoring tool, open source Redis Cluster monitoring tool, monitoring Redis Cluster metrics ]
---

@LiuTianyou
Copy link
Contributor

It is recommended to modify sidebars.json by the way, so that users can see the link to the document in the sidebar

Copy link
Member

@zuobiao-zhou zuobiao-zhou Jun 18, 2024

Choose a reason for hiding this comment

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

Hi, why add this doc to "version-v1.1.x" directory?

@zhangshenghang
Copy link
Member

This PR has not been updated for almost a month, I will continue to complete it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation good first pull request Good for newcomers
Projects
Development

Successfully merging this pull request may close these issues.

6 participants