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.

Sign up for GitHub

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

Jump to bottom

feat：align README documents in both English and Chinese #1342

Closed
caicancai opened this issue Dec 4, 2023 · 10 comments
Closed

feat：align README documents in both English and Chinese #1342

caicancai opened this issue Dec 4, 2023 · 10 comments
Assignees
@caicancai
Labels
docs Improvements or additions to documentation feature New feature or request

Comments

@caicancai
Copy link
Member

Describe This Problem

The README document and the REAME-CN content are not aligned.

Proposal

I think we should align the README English and Chinese documents

Additional Context

No response
@caicancai caicancai added the feature New feature or request label Dec 4, 2023
@tanruixiang
Copy link
Member

Thank you for your suggestions. The English version is expected to undergo a major revision in the coming weeks, so we can wait until the English version is revised and aligned.

@tanruixiang tanruixiang added the docs Improvements or additions to documentation label Dec 4, 2023
@caicancai
Copy link
Member Author

Thank you for your suggestions. The English version is expected to undergo a major revision in the coming weeks, so we can wait until the English version is revised and aligned.

Thank you for your reply. If you need help, I can provide it

@tanruixiang
Copy link
Member

Thank you for your reply. If you need help, I can provide it

Thank you for your help. I have assigned that task to you. I will call you in this ISSUE when the English version is revised.

@caicancai
Copy link
Member Author

@tanruixiang Hello，I found that README's docker link is wrong because horaedb-server doesn't exist in docker hub yet, and it's still ceresdb-server before, and I'm not sure if I want to fix it.
https://hub.docker.com/r/ceresdb/ceresdb-server

@caicancai
Copy link
Member Author

cc @tisonkun

@tisonkun
Copy link
Member

tisonkun commented Dec 4, 2023

because horaedb-server doesn't exist in docker hub yet

Let's hold a bit after repo transfer happened and new release happened.

You can go back here then.

@caicancai
Copy link
Member Author

because horaedb-server doesn't exist in docker hub yet

Let's hold a bit after repo transfer happened and new release happened.

You can go back here then.

thank you.

@tanruixiang
Copy link
Member

tanruixiang commented Dec 4, 2023 •
edited
Loading

@tanruixiang Hello，I found that README's docker link is wrong because horaedb-server doesn't exist in docker hub yet, and it's still ceresdb-server before, and I'm not sure if I want to fix it. https://hub.docker.com/r/ceresdb/ceresdb-server

Related with #1319 (comment). You can check out that issue for more context.
Anything related to the org name should need to wait for the org transfer.

@caicancai
Copy link
Member Author

@tanruixiang Hello，I found that README's docker link is wrong because horaedb-server doesn't exist in docker hub yet, and it's still ceresdb-server before, and I'm not sure if I want to fix it. https://hub.docker.com/r/ceresdb/ceresdb-server

Related with #1319 (comment). You can check out that issue for more context. Anything related to the org name should need to wait for the org transfer.

Thank you. I'll go look at the code first.

@caicancai caicancai mentioned this issue Dec 6, 2023
Merged
@caicancai caicancai mentioned this issue Dec 20, 2023
Merged
@caicancai
Copy link
Member Author

caicancai commented Dec 21, 2023 •
edited
Loading

@tanruixiang @tisonkun I noticed that there was a pr who did this part of my work

@caicancai caicancai mentioned this issue Dec 21, 2023
Merged
tanruixiang pushed a commit that referenced this issue Dec 22, 2023
@chunshao90 @caicancai
chore: update README (#1390)
be7bbd1 
## Rationale
related #1342
Add quick start to `README` to help users experience horaedb better.

## Detailed Changes
Add quick start to `README`.

## Test Plan
No need.

---------

Co-authored-by: caicancai <2356672992@qq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@caicancai caicancai

Labels
docs Improvements or additions to documentation feature New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@tisonkun @tanruixiang @caicancai