Skip to content

Commit 039af9f

Browse files
authored
chore: fix doc links (#1565)
1 parent 28e4760 commit 039af9f

File tree

3 files changed

+13
-19
lines changed

3 files changed

+13
-19
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ To make the process easier and more valuable for everyone involved we have a few
55

66
## Submitting Issues and Feature Requests
77

8-
Before you file an [issue](https://github.com/apache/incubator-horaedb/issues/new), please search existing issues in case the same or similar issues have already been filed.
8+
Before you file an [issue](https://github.com/apache/horaedb/issues/new), please search existing issues in case the same or similar issues have already been filed.
99
If you find an existing open ticket covering your issue then please avoid adding "👍" or "me too" comments; GitHub notifications can cause a lot of noise for the project maintainers who triage the back-log.
1010
However, if you have a new piece of information for an existing ticket, and you think it may help the investigation or resolution, then please do add it as a comment!
1111
You can signal to the team that you're experiencing an existing issue with one of GitHub's emoji reactions (these are a good way to add "weight" to an issue from a prioritisation perspective).
1212

1313
### Submitting an Issue
1414

15-
The [New Issue](https://github.com/apache/incubator-horaedb/issues/new) page has templates for both bug reports and feature requests.
15+
The [New Issue](https://github.com/apache/horaedb/issues/new) page has templates for both bug reports and feature requests.
1616
Please fill one of them out!
1717
The issue templates provide details on what information we will find useful to help us fix an issue.
1818
In short though, the more information you can provide us about your environment and what behaviour you're seeing, the easier we can fix the issue.
@@ -31,14 +31,14 @@ All code must adhere to the `rustfmt` format, and pass all of the `clippy` check
3131

3232
To open a PR you will need to have a GitHub account.
3333
Fork the `horaedb` repo and work on a branch on your fork.
34-
When you have completed your changes, or you want some incremental feedback make a Pull Request to HoraeDB [here](https://github.com/apache/incubator-horaedb/compare).
34+
When you have completed your changes, or you want some incremental feedback make a Pull Request to HoraeDB [here](https://github.com/apache/horaedb/compare).
3535

3636
If you want to discuss some work in progress then please prefix `[WIP]` to the
3737
PR title.
3838

3939
For PRs that you consider ready for review, verify the following locally before you submit it:
4040

41-
* you have a coherent set of logical commits, with messages conforming to the [Conventional Commits](https://horaedb.apache.org/dev/conventional_commit.html) specification;
41+
* you have a coherent set of logical commits, with messages conforming to the [Conventional Commits](https://horaedb.apache.org/docs/dev/conventional_commit/) specification;
4242
* all the tests and/or benchmarks pass, including documentation tests;
4343
* the code is correctly formatted and all `clippy` checks pass; and
4444
* you haven't left any "code cruft" (commented out code blocks etc).

README-CN.md

+6-11
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
![HoraeDB](docs/logo/horaedb-banner-white-small.jpg)
22

33
![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)
4-
[![CI](https://github.com/apache/incubator-horaedb/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/incubator-horaedb/actions/workflows/ci.yml)
5-
[![OpenIssue](https://img.shields.io/github/issues/apache/incubator-horaedb)](https://github.com/apache/incubator-horaedb/issues)
4+
[![CI](https://github.com/apache/horaedb/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/horaedb/actions/workflows/ci.yml)
5+
[![OpenIssue](https://img.shields.io/github/issues/apache/horaedb)](https://github.com/apache/horaedb/issues)
66
[![HoraeDB Docker](https://img.shields.io/docker/v/apache/horaedb-server?logo=docker&label=horaedb-server)](https://hub.docker.com/r/apache/horaedb-server)
77
[![HoraeMeta Docker](https://img.shields.io/docker/v/apache/horaemeta-server?logo=docker&label=horaemeta-server)](https://hub.docker.com/r/apache/horaemeta-server)
88

@@ -11,9 +11,9 @@
1111
Apache HoraeDB (incubating) 是一款高性能、分布式的云原生时序数据库。
1212

1313
## 文档
14-
- [用户文档](https://horaedb.apache.org)
15-
- [研发文档](https://horaedb.apache.org/dev/compile_run.html)
16-
- [Roadmap](https://horaedb.apache.org/dev/roadmap.html)
14+
15+
- [User Guide](https://horaedb.apache.org/docs/getting-started/)
16+
- [Development Guide](https://horaedb.apache.org/docs/dev/)
1717

1818
## 快速开始
1919
### 通过 Docker 运行
@@ -32,9 +32,6 @@ docker run -d --name horaedb-server \
3232
docker compose -f docker/docker-compose.yaml up
3333
```
3434

35-
### 通过源码编译运行
36-
详见[文档](https://horaedb.apache.org/dev/compile_run.html)
37-
3835
### 基本操作
3936

4037
创建表
@@ -84,9 +81,7 @@ Drop TABLE `demo`
8481

8582
- [订阅邮箱参与讨论](mailto:dev-subscribe@horaedb.apache.org) ([订阅](mailto:dev-subscribe@horaedb.apache.org?subject=(send%20this%20email%20to%20subscribe)) / [取消订阅](mailto:dev-unsubscribe@horaedb.apache.org?subject=(send%20this%20email%20to%20unsubscribe)) / [查看邮件历史记录](https://lists.apache.org/list.html?dev@horaedb.apache.org))
8683
- 发送 [请求](mailto:dev@horaedb.apache.org?subject=(Request%to%20join%20HoraeDB%20slack))`dev@horaedb.apache.org` 加入HoraeDB Slack
87-
- 通过[这里的链接](https://github.com/apache/incubator-horaedb-docs/blob/main/static/dingtalk.jpg),加入钉钉用户群
88-
89-
[约定式提交](https://apache.github.io/incubator-horaedb-docs/cn/dev/conventional_commit)
84+
- 通过[这里的链接](http://horaedb.apache.org/community/),加入我们的社区。
9085

9186
[如何参与贡献](CONTRIBUTING.md)
9287

README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@ Apache HoraeDB (incubating) is a high-performance, distributed, cloud native tim
1818
1919
## Documentation
2020

21-
- [User Guide](https://horaedb.apache.org)
22-
- [Development Guide](https://horaedb.apache.org/dev/compile_run.html)
23-
- [Roadmap](https://horaedb.apache.org/dev/roadmap.html)
21+
- [User Guide](https://horaedb.apache.org/docs/getting-started/)
22+
- [Development Guide](https://horaedb.apache.org/docs/dev/)
2423

2524
## Quick Start
2625

@@ -98,7 +97,7 @@ Thrive together in Apache HoraeDB (incubating) community with users and develope
9897

9998
- Discuss at [dev mailing list](mailto:dev-subscribe@horaedb.apache.org) ([subscribe](mailto:dev-subscribe@horaedb.apache.org?subject=(send%20this%20email%20to%20subscribe)) / [unsubscribe](mailto:dev-unsubscribe@horaedb.apache.org?subject=(send%20this%20email%20to%20unsubscribe)) / [archives](https://lists.apache.org/list.html?dev@horaedb.apache.org))
10099
- Send [request](mailto:dev@horaedb.apache.org?subject=(Request%to%20join%20HoraeDB%20slack)) to `dev@horaedb.apache.org` to join HoraeDB slack channel
101-
- Or you can join our [dingtalk group](https://github.com/apache/incubator-horaedb-docs/blob/main/static/dingtalk.jpg)
100+
- Or you can join our community [here](http://horaedb.apache.org/community/)
102101

103102
Read our [Contributing Guide](CONTRIBUTING.md) and make your first contribution!
104103

0 commit comments

Comments
 (0)