Skip to content

Commit

Permalink
docs: more readable
Browse files Browse the repository at this point in the history
  • Loading branch information
siyul-park committed Oct 8, 2024
1 parent dde76b3 commit 87b76c9
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 4 deletions.
3 changes: 2 additions & 1 deletion cmd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Before running commands, configure your system using environment variables. You
|-----------------------|----------------------------|----------------------------|
| `database.url` | `DATABASE.URL` | `mem://` or `mongodb://` |
| `database.name` | `DATABASE.NAME` | - |
| `collection.charts` | `COLLECTION.CHARTS` | `charts` |
| `collection.nodes` | `COLLECTION.NODES` | `nodes` |
| `collection.secrets` | `COLLECTION.SECRETS` | `secrets` |

If using [MongoDB](https://www.mongodb.com/), ensure that [Change Streams](https://www.mongodb.com/docs/manual/changeStreams/) are enabled so that the engine can track changes to node specifications. To utilize Change Streams, set up a [Replica Set](https://www.mongodb.com/docs/manual/replication/#std-label-replication).
If using [MongoDB](https://www.mongodb.com/), ensure that [Change Streams](https://www.mongodb.com/docs/manual/changeStreams/) are enabled so that the engine can track changes to resources. To utilize Change Streams, set up a [Replica Set](https://www.mongodb.com/docs/manual/replication/#std-label-replication).
3 changes: 2 additions & 1 deletion cmd/README_kr.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
|----------------------|--------------------------|----------------------------|
| `database.url` | `DATABASE.URL` | `mem://` 또는 `mongodb://` |
| `database.name` | `DATABASE.NAME` | - |
| `collection.charts` | `COLLECTION.CHARTS` | `charts` |
| `collection.nodes` | `COLLECTION.NODES` | `nodes` |
| `collection.secrets` | `COLLECTION.SECRETS` | `secrets` |

[MongoDB](https://www.mongodb.com/)를 사용할 경우, 엔진이 노드 명세의 변경을 추적할 수 있도록 [변경 스트림](https://www.mongodb.com/docs/manual/changeStreams/)을 활성화해야 합니다. 변경 스트림을 이용하려면 [복제본 세트](https://www.mongodb.com/ko-kr/docs/manual/replication/#std-label-replication)를 설정하세요.
[MongoDB](https://www.mongodb.com/)를 사용할 경우, 엔진이 리소스의 변경을 추적할 수 있도록 [변경 스트림](https://www.mongodb.com/docs/manual/changeStreams/)을 활성화해야 합니다. 변경 스트림을 이용하려면 [복제본 세트](https://www.mongodb.com/ko-kr/docs/manual/replication/#std-label-replication)를 설정하세요.
1 change: 1 addition & 0 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Settings can be modified using the `.uniflow.toml` file or system environment va
|----------------------|--------------------------|-----------------------------|
| `database.url` | `DATABASE.URL` | `mem://` or `mongodb://` |
| `database.name` | `DATABASE.NAME` | - |
| `collection.charts` | `COLLECTION.CHARTS` | `charts` |
| `collection.nodes` | `COLLECTION.NODES` | `nodes` |
| `collection.secrets` | `COLLECTION.SECRETS` | `secrets` |

Expand Down
1 change: 1 addition & 0 deletions docs/getting_started_kr.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ make build
|----------------------|-------------------------|----------------------------|
| `database.url` | `DATABASE.URL` | `mem://` 또는 `mongodb://` |
| `database.name` | `DATABASE.NAME` | - |
| `collection.charts` | `COLLECTION.CHARTS` | `charts` |
| `collection.nodes` | `COLLECTION.NODES` | `nodes` |
| `collection.secrets` | `COLLECTION.SECRETS` | `secrets` |

Expand Down
2 changes: 1 addition & 1 deletion docs/key_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ data:

## Chart

A chart defines a node that combines multiple node specifications to perform more complex operations. Charts are used to set up interactions between nodes.
A chart defines a node that combines multiple nodes to perform more complex operations. Charts are used to set up interactions between nodes.

```yaml
id: 01908c74-8b22-7cbf-a475-6b6bc871b01b
Expand Down
2 changes: 1 addition & 1 deletion docs/key_concepts_kr.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ data:

## 차트

차트는 여러 개의 노드 명세를 결합하여 더 복잡한 동작을 수행하는 노드를 정의합니다. 차트는 노드들 간의 상호 작용을 설정하는 데 사용됩니다.
차트는 여러 개의 노드를 결합하여 더 복잡한 동작을 수행하는 노드를 정의합니다. 차트는 노드들 간의 상호 작용을 설정하는 데 사용됩니다.

```yaml
id: 01908c74-8b22-7cbf-a475-6b6bc871b01b
Expand Down

0 comments on commit 87b76c9

Please sign in to comment.