Skip to content

Commit

Permalink
[fix chinese char in doc] (StarRocks#22159)
Browse files Browse the repository at this point in the history
Signed-off-by: evelynzhaojie <everlyn.zhaojie@gmail.com>
  • Loading branch information
evelynzhaojie authored Apr 21, 2023
1 parent 4fff6e8 commit 6d7cc91
Show file tree
Hide file tree
Showing 77 changed files with 254 additions and 275 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Learn more 👉🏻 [Introduction to StarRocks](https://www.starrocks.io/blog/in
</a>
</p>

StarRocks’s streamlined architecture is mainly composed of two modulesFrontend (FE) and Backend (BE). The entire system eliminates single points of failure through seamless and horizontal scaling of FE and BE, as well as replication of metadata and data.
StarRocks’s streamlined architecture is mainly composed of two modules: Frontend (FE) and Backend (BE). The entire system eliminates single points of failure through seamless and horizontal scaling of FE and BE, as well as replication of metadata and data.

<br>

Expand Down
86 changes: 43 additions & 43 deletions community/membership.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,82 @@

| Role | Responsibilities | Requirements |
| -----| ---------------- | ------------ |
| -----| ---------------- | ------------ |
| Contributor | Active participant in the community | Finish at least one contribution to the project in specific repos |
| Active Contributor | Active contributor in the community | Have 5 merged PRs or fixed major bugs|
| Committer | Contributions acceptance approval| Have proven track record of contributions and lead major development. Nominees must be approved by a majority vote of the TSC voting members.|
| Maintainer | A maintainer makes and approves technical design decisions. Define milestones and releases. Elect new community members.| Highly experienced committer. Nominees must be approved by a majority vote of the TSC voting members.|
| Active Contributor | Active contributor in the community | Have 5 merged PRs or fixed major bugs|
| Committer | Contributions acceptance approval| Have proven track record of contributions and lead major development. Nominees must be approved by a majority vote of the TSC voting members.|
| Maintainer | A maintainer makes and approves technical design decisions. Define milestones and releases. Elect new community members.| Highly experienced committer. Nominees must be approved by a majority vote of the TSC voting members.|

**Note:** This document is a work in progress.
This doc outlines the various responsibilities of contributor roles in StarRocks.

## Contributor

Everyone who contributes can become a StarRocks contributor. The members will provide mentorship and guidance when new contributors need assistance.

### How to become a Contributor?
- 1 merged PR (pull request) in StarRocks' repositories

### As a Contributor, we expect you to:
- Actively participate in the development of the StarRocks project
- Attend community events such as meetups and hackathons
- Continuously learn about StarRocks-related technologies and share your knowledge with others
- 1 merged PR (pull request) in StarRocks' repositories

### As a Contributor, we expect you to:

### Privileges:
- Be recognized as a StarRocks Contributor
- Actively participate in the development of the StarRocks project
- Attend community events such as meetups and hackathons
- Continuously learn about StarRocks-related technologies and share your knowledge with others

### Privileges

- Be recognized as a StarRocks Contributor

## Active Contributor

Active contributors are contributors who have made outstanding contributions and sustained commitment to StarRocks. They actively participate in the community by contributing code, improving docs and helping others.

### How to become an Active Contributor?

- Have at least 5 merged PRs or have fixed major bugs
- Participate in at least 5 code reviews
- Actively engage with the community by attending online or offline meetups and participating in community discussions
- Have at least 5 merged PRs or have fixed major bugs
- Participate in at least 5 code reviews
- Actively engage with the community by attending online or offline meetups and participating in community discussions

### Responsibilities and privileges:

- Join the community meeting and discussion
- Mentor and guide new contributors
- Be recognized as a StarRocks Active Contributor
### Responsibilities and privileges

- Join the community meeting and discussion
- Mentor and guide new contributors
- Be recognized as a StarRocks Active Contributor

## Committer

Committers are Contributors who have earned the ability to modify (commit) source code, documentation or other technical artifacts in a project’s repository.
Committers are Contributors who have earned the ability to modify ("commit") source code, documentation or other technical artifacts in a project’s repository.

### How to become a Committer?

- Have a deep understanding of StarRocks' principles and future plans
- Have the ability to deal with various issues that arise in the project promptly
- Lead at least one major development, write and revise related documents
- A contributor may become a Committer by a majority approval of the voting members of the TSC as defined in the Technical Charter.

### Responsibilities and privileges:
- Have a deep understanding of StarRocks' principles and future plans
- Have the ability to deal with various issues that arise in the project promptly
- Lead at least one major development, write and revise related documents
- A contributor may become a Committer by a majority approval of the voting members of the TSC as defined in the Technical Charter.

- Mentor and guide other members in the community
- Ensure continued health of subproject
- Be granted write access to StarRocks repos (to be specified)
- Be recognized as a StarRocks Committer
### Responsibilities and privileges

- Mentor and guide other members in the community
- Ensure continued health of subproject
- Be granted write access to StarRocks repos (to be specified)
- Be recognized as a StarRocks Committer

## Maintainer

Maintainers are a subset of Committers with additional responsibilities for driving a project’s release and serving on the TSC.

### How to become a PMC?

- In-depth understanding of StarRocks principles and a clear understanding of StarRocks' future plans
- Have the ability to deal with project issues promptly
- Lead project development and iterations, and steer the overall direction of the project
- A Committer may become a Maintainer by a majority approval of the existing Maintainers as defined in the Technical Charter.


### Responsibilities and privileges:
- In-depth understanding of StarRocks principles and a clear understanding of StarRocks' future plans
- Have the ability to deal with project issues promptly
- Lead project development and iterations, and steer the overall direction of the project
- A Committer may become a Maintainer by a majority approval of the existing Maintainers as defined in the Technical Charter.

- Mentor and guide other members in the community
- Ensure continued health of the project, such as code quality and test coverage
- Make and approve technical design decisions
- Define milestones and releases
- Vote and promote new TSC members (Committers and Maintainers)
- Be recognized as a StarRocks Maintainer
### Responsibilities and privileges

- Mentor and guide other members in the community
- Ensure continued health of the project, such as code quality and test coverage
- Make and approve technical design decisions
- Define milestones and releases
- Vote and promote new TSC members (Committers and Maintainers)
- Be recognized as a StarRocks Maintainer
2 changes: 1 addition & 1 deletion docs/administration/Blacklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ ADD SQLBLACKLIST "select count(\\*) from .+"
ADD SQLBLACKLIST "select count(distinct .+) from .+"
~~~

* Prohibit order by limit x, y1 <= x <=7, 5 <=y <=7:
* Prohibit order by limit x, y, 1 <= x <=7, 5 <=y <=7:

~~~sql
ADD SQLBLACKLIST "select id_int from test_all_type_select1 order by id_int limit [1-7], [5-7]"
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/Replica.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* TabletChecker (TC): A resident background thread that periodically scans all Tablets and decides whether to send tablets to TabletScheduler based on their status.
* TabletScheduler (TS): A resident background thread that processes tablets sent by TabletChecker, and also performs cluster replica balancing.
* TabletSchedCtx (TSC): A wrapper for a tablet. When a tablet is selected by TC, it is encapsulated as a TSC and sent to TS.
* Storage MediumStarRocks supports different storage media for partition granularity, including SSD and HDD. The scheduling of replicas varies for different storage media.
* Storage Medium: StarRocks supports different storage media for partition granularity, including SSD and HDD. The scheduling of replicas varies for different storage media.

## Status

Expand Down
10 changes: 5 additions & 5 deletions docs/administration/audit_loader.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ CREATE TABLE starrocks_audit_db__.starrocks_audit_tbl__ (
`user` VARCHAR(64) COMMENT "User who initiates the query",
`resourceGroup` VARCHAR(64) COMMENT "Resource group name",
`db` VARCHAR(96) COMMENT "Database that the query scans",
`state` VARCHAR(8) COMMENT "Query state (EOFERROK)",
`state` VARCHAR(8) COMMENT "Query state (EOF, ERR, OK)",
`errorCode` VARCHAR(96) COMMENT "Error code",
`queryTime` BIGINT COMMENT "Query latency in milliseconds",
`scanBytes` BIGINT COMMENT "Size of the scanned data in bytes",
Expand Down Expand Up @@ -67,7 +67,7 @@ CREATE TABLE starrocks_audit_db__.starrocks_audit_tbl__ (
`user` VARCHAR(64) COMMENT "User who initiates the query",
`resourceGroup` VARCHAR(64) COMMENT "Resource group name",
`db` VARCHAR(96) COMMENT "Database that the query scans",
`state` VARCHAR(8) COMMENT "Query state (EOFERROK)",
`state` VARCHAR(8) COMMENT "Query state (EOF, ERR, OK)",
`errorCode` VARCHAR(96) COMMENT "Error code",
`queryTime` BIGINT COMMENT "Query latency in milliseconds",
`scanBytes` BIGINT COMMENT "Size of the scanned data in bytes",
Expand Down Expand Up @@ -109,7 +109,7 @@ CREATE TABLE starrocks_audit_db__.starrocks_audit_tbl__
client_ip VARCHAR(32) COMMENT "Client IP address",
user VARCHAR(64) COMMENT "User who initiates the query",
db VARCHAR(96) COMMENT "Database that the query scans",
state VARCHAR(8) COMMENT "Query state (EOFERROK)",
state VARCHAR(8) COMMENT "Query state (EOF, ERR, OK)",
query_time BIGINT COMMENT "Query latency in milliseconds",
scan_bytes BIGINT COMMENT "Size of the scanned data in bytes",
scan_rows BIGINT COMMENT "Row count of the scanned data",
Expand Down Expand Up @@ -147,7 +147,7 @@ CREATE TABLE starrocks_audit_db__.starrocks_audit_tbl__
client_ip VARCHAR(32) COMMENT "Client IP address",
user VARCHAR(64) COMMENT "User who initiates the query",
db VARCHAR(96) COMMENT "Database that the query scans",
state VARCHAR(8) COMMENT "Query state (EOF,ERR,OK)",
state VARCHAR(8) COMMENT "Query state (EOFE, RR, OK)",
query_time BIGINT COMMENT "Query latency in milliseconds",
scan_bytes BIGINT COMMENT "Size of the scanned data in bytes",
scan_rows BIGINT COMMENT "Row count of the scanned data",
Expand Down Expand Up @@ -183,7 +183,7 @@ CREATE TABLE starrocks_audit_db__.starrocks_audit_tbl__
client_ip VARCHAR(32) COMMENT "Client IP address",
user VARCHAR(64) COMMENT "User who initiates the query",
db VARCHAR(96) COMMENT "Database that the query scans",
state VARCHAR(8) COMMENT "Query state (EOFERROK)",
state VARCHAR(8) COMMENT "Query state (EOF, ERR, OK)",
query_time BIGINT COMMENT "Query latency in milliseconds",
scan_bytes BIGINT COMMENT "Size of the scanned data in bytes",
scan_rows BIGINT COMMENT "Row count of the scanned data",
Expand Down
6 changes: 3 additions & 3 deletions docs/administration/privilege_item.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ This section describes privileges that are available on different objects.

| Object | Privilege | Description |
| --------------------------- | ----------------------------------------------------- | ---------------------------------------------- |
| CATALOGinternal catalog) | USAGE | Uses the internal catalog (default_catalog). |
| CATALOGinternal catalog) | CREATE DATABASE | Creates databases in the internal catalog. |
| CATALOGinternal catalog) | ALL | Has all the above privileges on the internal catalog. |
| CATALOG (internal catalog) | USAGE | Uses the internal catalog (default_catalog). |
| CATALOG (internal catalog) | CREATE DATABASE | Creates databases in the internal catalog. |
| CATALOG (internal catalog) | ALL | Has all the above privileges on the internal catalog. |
| CATALOG (external catalog) | USAGE | Uses an external catalog to view tables in it. |
| CATALOG (external catalog) | DROP | Deletes an external catalog. |
| CATALOG (external catalog) | ALL | Has all the above privileges on the external catalog. |
Expand Down
6 changes: 3 additions & 3 deletions docs/administration/resource_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ A classifier matches a query only when one or all conditions of the classifier m
>
> If a query does not hit any classifiers, the default resource group `default_wg` is used. The resource limits of `default_wg` are as follows:
>
> - `cpu_core_limit`: 1 (<= v2.3.7) or the number of CPU cores in BE> v2.3.7)
> - `cpu_core_limit`: 1 (<= v2.3.7) or the number of CPU cores in BE (> v2.3.7)
> - `mem_limit`: 100%
> - `concurrency_limit`: 0
> - `big_query_cpu_second_limit`: 0
Expand Down Expand Up @@ -139,7 +139,7 @@ classifier B (user='Alice', source_ip = '192.168.1.0/24')
-- Classifier C has fewer query types specified in it than Classifier D. Therefore, Classifier C has a higher degree of matching than Classifier D.
classifier C (user='Alice', query_type in ('select'))
classifier D (user='Alice', query_type in ('insert','select')
classifier D (user='Alice', query_type in ('insert','select'))
```

## Isolate computing resources
Expand Down Expand Up @@ -224,7 +224,7 @@ SHOW RESOURCE GROUPS;
Execute the following statement to query a specified resource group and its classifiers:

```SQL
SHOW RESOURCE GROUP group_name
SHOW RESOURCE GROUP group_name;
```

Example:
Expand Down
10 changes: 5 additions & 5 deletions docs/data_source/External_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ StarRocks supports access to other data sources by using external tables. Extern
>
> Since v3.0, we recommend that you use catalogs to query Hive, Iceberg, and Hudi data. See [Hive catalog](../data_source/catalog/hive_catalog.md), [Iceberg catalog](../data_source/catalog/iceberg_catalog.md), and [Hudi catalog](../data_source/catalog/hudi_catalog.md).
From 2.5 onwards, StarRocks provides the Local Cache feature, which accelerates hot data queriers on external data sources. For more information, see [Local Cache](Block_cache.md)
From 2.5 onwards, StarRocks provides the Local Cache feature, which accelerates hot data queriers on external data sources. For more information, see [Local Cache](Block_cache.md).

## MySQL external table

Expand Down Expand Up @@ -94,7 +94,7 @@ insert into external_t values ('2020-10-11', 1, 1, 'hello', '2020-10-11 10:00:00
insert into external_t select * from other_table;
~~~

Parameters
Parameters:

* **EXTERNAL:** This keyword indicates that the table to be created is an external table.
* **host:** This parameter specifies the IP address of the leader FE node of the destination StarRocks cluster.
Expand Down Expand Up @@ -472,7 +472,7 @@ The required parameters in `properties` are as follows:

* `resource`: the name of the JDBC resource used to create the external table.

* `table`the target table name in the database.
* `table`: the target table name in the database.

For supported data types and data type mapping between StarRocks and target databases, see [Data type mapping](External_table.md#Data type mapping).

Expand Down Expand Up @@ -696,13 +696,13 @@ select count(*) from profile_wos_p7;

### Configuration

* The path of the FE configuration file is `fe/conf`, to which the configuration file can be added if you need to customize the Hadoop cluster. For example: HDFS cluster uses a highly available nameservice, you need to put `hdfs-site.xml` under `fe/conf`. If HDFS is configured with viewfs, you need to put the `core-site.xml` under `fe/conf`.
* The path of the FE configuration file is `fe/conf`, to which the configuration file can be added if you need to customize the Hadoop cluster. For example: HDFS cluster uses a highly available nameservice, you need to put `hdfs-site.xml` under `fe/conf`. If HDFS is configured with viewfs, you need to put the `core-site.xml` under `fe/conf`.
* The path of the BE configuration file is `be/conf`, to which configuration file can be added if you need to customize the Hadoop cluster. For example, HDFS cluster using a highly available nameservice, you need to put `hdfs-site.xml` under `be/conf`. If HDFS is configured with viewfs, you need to put `core-site.xml` under `be/conf`.
* The machine where BE is located need to configure JAVA_HOME as a jdk environment rather than a jre environment
* kerberos supports:
1. To log in with `kinit -kt keytab_path principal` to all FE/BE machines, you need to have access to Hive and HDFS. The kinit command login is only good for a period of time and needs to be put into crontab to be executed regularly.
2. Put `hive-site.xml/core-site.xml/hdfs-site.xml` under `fe/conf`, and put `core-site.xml/hdfs-site.xml` under `be/conf`.
3. Add **Djava.security.krb5.conf:/etc/krb5.conf** to the **JAVA_OPTS/JAVA_OPTS_FOR_JDK_9** option of the **fe/conf/fe.conf** file. **/etc/krb5.conf** is the path of the **krb5.conf** file. You can adjust the path based on your operating system.
3. Add **Djava.security.krb5.conf:/etc/krb5.conf** to the **JAVA_OPTS/JAVA_OPTS_FOR_JDK_9** option of the **fe/conf/fe.conf** file. **/etc/krb5.conf** is the path of the **krb5.conf** file. You can adjust the path based on your operating system.
4. When you add a Hive resource, you must pass in a domain name to `hive.metastore.uris`. In addition, you must add the mapping between Hive/HDFS domain names and IP addresses in the **/etc/hosts** file*.*

* Configure support for AWS S3: Add the following configuration to `fe/conf/core-site.xml` and `be/conf/core-site.xml`.
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/debuginfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This change does not affect your download behavior or use of StarRocks. You can

> **NOTE**
>
> Replace `<sr_ver>` with the version number of the StarRocks installation package you want to download
> Replace `<sr_ver>` with the version number of the StarRocks installation package you want to download.

2. Load the debuginfo file when you perform GDB debugging.

Expand Down
Loading

0 comments on commit 6d7cc91

Please sign in to comment.