diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58a524bd09..2f9bd85713 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,14 +5,14 @@ To make the process easier and more valuable for everyone involved we have a few ## Submitting Issues and Feature Requests -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. +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. 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. 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! 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). ### Submitting an Issue -The [New Issue](https://github.com/apache/incubator-horaedb/issues/new) page has templates for both bug reports and feature requests. +The [New Issue](https://github.com/apache/horaedb/issues/new) page has templates for both bug reports and feature requests. Please fill one of them out! The issue templates provide details on what information we will find useful to help us fix an issue. 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 To open a PR you will need to have a GitHub account. Fork the `horaedb` repo and work on a branch on your fork. -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). +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). If you want to discuss some work in progress then please prefix `[WIP]` to the PR title. For PRs that you consider ready for review, verify the following locally before you submit it: -* you have a coherent set of logical commits, with messages conforming to the [Conventional Commits](https://horaedb.apache.org/dev/conventional_commit.html) specification; +* you have a coherent set of logical commits, with messages conforming to the [Conventional Commits](https://horaedb.apache.org/docs/dev/conventional_commit/) specification; * all the tests and/or benchmarks pass, including documentation tests; * the code is correctly formatted and all `clippy` checks pass; and * you haven't left any "code cruft" (commented out code blocks etc). diff --git a/README-CN.md b/README-CN.md index 01b483ea6d..81d1bad725 100644 --- a/README-CN.md +++ b/README-CN.md @@ -1,8 +1,8 @@ ![HoraeDB](docs/logo/horaedb-banner-white-small.jpg) ![License](https://img.shields.io/badge/license-Apache--2.0-green.svg) -[![CI](https://github.com/apache/incubator-horaedb/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/incubator-horaedb/actions/workflows/ci.yml) -[![OpenIssue](https://img.shields.io/github/issues/apache/incubator-horaedb)](https://github.com/apache/incubator-horaedb/issues) +[![CI](https://github.com/apache/horaedb/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/horaedb/actions/workflows/ci.yml) +[![OpenIssue](https://img.shields.io/github/issues/apache/horaedb)](https://github.com/apache/horaedb/issues) [![HoraeDB Docker](https://img.shields.io/docker/v/apache/horaedb-server?logo=docker&label=horaedb-server)](https://hub.docker.com/r/apache/horaedb-server) [![HoraeMeta Docker](https://img.shields.io/docker/v/apache/horaemeta-server?logo=docker&label=horaemeta-server)](https://hub.docker.com/r/apache/horaemeta-server) @@ -11,9 +11,9 @@ Apache HoraeDB (incubating) 是一款高性能、分布式的云原生时序数据库。 ## 文档 -- [用户文档](https://horaedb.apache.org) -- [研发文档](https://horaedb.apache.org/dev/compile_run.html) -- [Roadmap](https://horaedb.apache.org/dev/roadmap.html) + +- [User Guide](https://horaedb.apache.org/docs/getting-started/) +- [Development Guide](https://horaedb.apache.org/docs/dev/) ## 快速开始 ### 通过 Docker 运行 @@ -32,9 +32,6 @@ docker run -d --name horaedb-server \ docker compose -f docker/docker-compose.yaml up ``` -### 通过源码编译运行 -详见[文档](https://horaedb.apache.org/dev/compile_run.html)。 - ### 基本操作 创建表 @@ -84,9 +81,7 @@ Drop TABLE `demo` - [订阅邮箱参与讨论](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)) - 发送 [请求](mailto:dev@horaedb.apache.org?subject=(Request%to%20join%20HoraeDB%20slack)) 至 `dev@horaedb.apache.org` 加入HoraeDB Slack -- 通过[这里的链接](https://github.com/apache/incubator-horaedb-docs/blob/main/static/dingtalk.jpg)，加入钉钉用户群 - -[约定式提交](https://apache.github.io/incubator-horaedb-docs/cn/dev/conventional_commit) +- 通过[这里的链接](http://horaedb.apache.org/community/)，加入我们的社区。 [如何参与贡献](CONTRIBUTING.md) diff --git a/README.md b/README.md index 40262b04d5..26ef706bc9 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,8 @@ Apache HoraeDB (incubating) is a high-performance, distributed, cloud native tim ## Documentation -- [User Guide](https://horaedb.apache.org) -- [Development Guide](https://horaedb.apache.org/dev/compile_run.html) -- [Roadmap](https://horaedb.apache.org/dev/roadmap.html) +- [User Guide](https://horaedb.apache.org/docs/getting-started/) +- [Development Guide](https://horaedb.apache.org/docs/dev/) ## Quick Start @@ -98,7 +97,7 @@ Thrive together in Apache HoraeDB (incubating) community with users and develope - 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)) - Send [request](mailto:dev@horaedb.apache.org?subject=(Request%to%20join%20HoraeDB%20slack)) to `dev@horaedb.apache.org` to join HoraeDB slack channel -- Or you can join our [dingtalk group](https://github.com/apache/incubator-horaedb-docs/blob/main/static/dingtalk.jpg) +- Or you can join our community [here](http://horaedb.apache.org/community/) Read our [Contributing Guide](CONTRIBUTING.md) and make your first contribution!