Skip to content

Commit

Permalink
doc: update to new github note syntax (#13646)
Browse files Browse the repository at this point in the history
  • Loading branch information
xxchan authored Nov 27, 2023
1 parent a3ea7c0 commit f92b501
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ To clean all data, run:
docker-compose down -v
```

> **Note**
> [!NOTE]
>
> For RisingWave kernel hackers, we always recommend using [risedev](../src/risedevtool/README.md) to start the full cluster, instead of using docker images.
> See [CONTRIBUTING](../CONTRIBUTING.md) for more information.
Expand Down
8 changes: 4 additions & 4 deletions docs/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Then you'll be able to compile and start RiseDev!

> **Note**
> [!NOTE]
>
> `.cargo/config.toml` contains `rustflags` configurations like `-Clink-arg` and `-Ctarget-feature`. Since it will be [merged](https://doc.rust-lang.org/cargo/reference/config.html#hierarchical-structure) with `$HOME/.cargo/config.toml`, check the config files and make sure they don't conflict if you have global `rustflags` configurations for e.g. linker there.
Expand Down Expand Up @@ -145,7 +145,7 @@ To manually add those components into the cluster, you will need to configure Ri
./risedev configure enable prometheus-and-grafana # enable Prometheus and Grafana
./risedev configure enable minio # enable MinIO
```
> **Note**
> [!NOTE]
>
> Enabling a component with the `./risedev configure enable` command will only download the component to your environment. To allow it to function, you must revise the corresponding configuration setting in `risedev.yml` and restart the dev cluster.
Expand All @@ -165,7 +165,7 @@ For example, you can modify the default section to:
persist-data: true
```
> **Note**
> [!NOTE]
>
> The Kafka service depends on the ZooKeeper service. If you want to enable the Kafka component, enable the ZooKeeper component first.
Expand Down Expand Up @@ -335,7 +335,7 @@ Then to run the end-to-end tests, you can use one of the following commands acco
./risedev slt-all -p 4566 -d dev -j 1
```

> **Note**
> [!NOTE]
>
> Use `-j 1` to create a separate database for each test case, which can ensure that previous test case failure won't affect other tests due to table cleanups.
Expand Down
2 changes: 1 addition & 1 deletion e2e_test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Refer to Sqllogictest [Doc](https://www.sqlite.org/sqllogictest/doc/trunk/about.

Refer to risingwave [developer guide](../docs/developer-guide.md#end-to-end-tests).

> **Note**
> [!NOTE]
>
> Usually you will just need to run either batch tests or streaming tests. Other tests may need to be run under some specific settings, e.g., ddl tests need to be run on a fresh instance, and database tests need to first create a database and then connect to that database to run tests.
>
Expand Down
2 changes: 1 addition & 1 deletion src/risedevtool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ All steps for downloading components, copying config, and building RisingWave ar
`risedev.yml` is powerful yet simple. If you want to make changes to the configuration format, you may need to understand how it works. Source code is in `risedevtool/src/config`.
> **Note**
> [!NOTE]
>
> The schema for RiseDev configuration files is defined under `src/risedevtool/schemas`.
>
Expand Down

0 comments on commit f92b501

Please sign in to comment.