Skip to content

Commit f9e5049

Browse files
[Doc] add "compile with Docker" and "deploy manually" steps for contributors (backport StarRocks#49354) (StarRocks#49400)
Co-authored-by: Yinzuo Jiang <[email protected]>
1 parent f3bd00b commit f9e5049

File tree

5 files changed

+15
-1
lines changed

5 files changed

+15
-1
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ TBC
8383

8484
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).
8585
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).
86+
3. To compile StarRocks with Docker, see [Compile StarRocks with Docker](https://docs.starrocks.io/docs/developers/build-starrocks/Build_in_docker/).
87+
4. To deploy StarRocks manually, see [Deploy StarRocks manually](https://docs.starrocks.io/docs/deployment/deploy_manually/).
8688

8789
#### Coding style
8890

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,8 @@ We welcome all kinds of contributions from the community, individuals and partne
108108
1. See [Contributing.md](https://github.com/StarRocks/starrocks/blob/main/CONTRIBUTING.md) to get started.
109109
2. Set up StarRocks development environment:
110110
* [IDE Setup](https://docs.starrocks.io/docs/developers/development-environment/ide-setup/)
111+
* [Compile StarRocks with Docker](https://docs.starrocks.io/docs/developers/build-starrocks/Build_in_docker/)
112+
* [Deploy StarRocks manually](https://docs.starrocks.io/docs/deployment/deploy_manually/)
111113
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.
112114
4. Pick a [good first issue](https://github.com/StarRocks/starrocks/labels/good%20first%20issue) and start contributing.
113115

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,5 +69,5 @@ Before contributing, please read this article carefully to quickly understand th
6969

7070
- [SQL function template](../docs/en/sql-reference/How_to_Write_Functions_Documentation.md)
7171
- [SQL command template](../docs/en/sql-reference//SQL_command_template.md)
72-
- [FE/BE config and variable temple](../docs/en/sql-reference/template_for_config.md)
72+
- [FE/BE config and variable template](../docs/en/sql-reference/template_for_config.md)
7373
- [Loading data template](../docs/en/loading/Loading_data_template.md)

docs/en/deployment/deploy_manually.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,11 @@ The following procedures are performed on the BE instances.
166166
> **NOTE**
167167
>
168168
> A high-availability cluster of BEs is automatically formed when at least three BE nodes are deployed and added to a StarRocks cluster.
169+
> 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**.
170+
171+
```YAML
172+
default_replication_num = 1
173+
```
169174

170175
## Step 3: (Optional) Start the CN service
171176

docs/zh/deployment/deploy_manually.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,11 @@ displayed_sidebar: "Chinese"
170170
> **说明**
171171
>
172172
> 在一个 StarRocks 集群中部署并添加至少 3 个 BE 节点后,这些节点将自动形成一个 BE 高可用集群。
173+
> 如果您只想部署一个 BE 节点,您必须在 FE 配置文件 **fe/conf/fe.conf** 中设置 `default_replication_num` 为 `1`。
174+
175+
```YAML
176+
default_replication_num = 1
177+
```
173178

174179
## 第三步:(可选)启动 CN 服务
175180

0 commit comments

Comments
 (0)