[Doc] add "compile with Docker" and "deploy manually" steps for contributors (backport #49354) (#49400)

Co-authored-by: Yinzuo Jiang <jiangyinzuo@foxmail.com>
This commit is contained in:
mergify[bot] 2024-08-08 07:09:18 +00:00 committed by GitHub
parent f3bd00bef4
commit f9e5049266
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 15 additions and 1 deletions

View File

@ -83,6 +83,8 @@ TBC
1. For FE development environment, see [The development configuration setup for StarRocks on IDEA](https://github.com/StarRocks/community/blob/main/Contributors/guide/IDEA.md).
2. For BE development environment, see [The development configuration setup for StarRocks on Clion](https://github.com/StarRocks/community/blob/main/Contributors/guide/Clion.md).
3. To compile StarRocks with Docker, see [Compile StarRocks with Docker](https://docs.starrocks.io/docs/developers/build-starrocks/Build_in_docker/).
4. To deploy StarRocks manually, see [Deploy StarRocks manually](https://docs.starrocks.io/docs/deployment/deploy_manually/).
#### Coding style

View File

@ -108,6 +108,8 @@ We welcome all kinds of contributions from the community, individuals and partne
1. See [Contributing.md](https://github.com/StarRocks/starrocks/blob/main/CONTRIBUTING.md) to get started.
2. Set up StarRocks development environment:
* [IDE Setup](https://docs.starrocks.io/docs/developers/development-environment/ide-setup/)
* [Compile StarRocks with Docker](https://docs.starrocks.io/docs/developers/build-starrocks/Build_in_docker/)
* [Deploy StarRocks manually](https://docs.starrocks.io/docs/deployment/deploy_manually/)
3. Understand our [GitHub workflow](https://github.com/StarRocks/community/blob/main/Contributors/guide/workflow.md) for opening a pull request; use this [PR Template](https://github.com/StarRocks/starrocks/blob/main/.github/PULL_REQUEST_TEMPLATE.md) when submitting a pull request.
4. Pick a [good first issue](https://github.com/StarRocks/starrocks/labels/good%20first%20issue) and start contributing.

View File

@ -69,5 +69,5 @@ Before contributing, please read this article carefully to quickly understand th
- [SQL function template](../docs/en/sql-reference/How_to_Write_Functions_Documentation.md)
- [SQL command template](../docs/en/sql-reference//SQL_command_template.md)
- [FE/BE config and variable temple](../docs/en/sql-reference/template_for_config.md)
- [FE/BE config and variable template](../docs/en/sql-reference/template_for_config.md)
- [Loading data template](../docs/en/loading/Loading_data_template.md)

View File

@ -166,6 +166,11 @@ The following procedures are performed on the BE instances.
> **NOTE**
>
> A high-availability cluster of BEs is automatically formed when at least three BE nodes are deployed and added to a StarRocks cluster.
> If you want to deploy just one BE node, you must set `default_replication_num` to `1` in the FE configuration file **fe/conf/fe.conf**.
```YAML
default_replication_num = 1
```
## Step 3: (Optional) Start the CN service

View File

@ -170,6 +170,11 @@ displayed_sidebar: "Chinese"
> **说明**
>
> 在一个 StarRocks 集群中部署并添加至少 3 个 BE 节点后,这些节点将自动形成一个 BE 高可用集群。
> 如果您只想部署一个 BE 节点,您必须在 FE 配置文件 **fe/conf/fe.conf** 中设置 `default_replication_num``1`
```YAML
default_replication_num = 1
```
## 第三步:(可选)启动 CN 服务