From 531f2f7f6c434e0f88157b792d20cb07aea45f89 Mon Sep 17 00:00:00 2001 From: xxchan Date: Fri, 24 Nov 2023 22:48:24 +0800 Subject: [PATCH] doc: update to new github note syntax https://github.com/orgs/community/discussions/16925 --- docker/README.md | 2 +- docs/developer-guide.md | 8 ++++---- e2e_test/README.md | 2 +- src/risedevtool/README.md | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docker/README.md b/docker/README.md index 2da87c9f85907..0be806c674e6d 100644 --- a/docker/README.md +++ b/docker/README.md @@ -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. diff --git a/docs/developer-guide.md b/docs/developer-guide.md index f01a8414eebbf..81e9aae0048bb 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -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. @@ -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. @@ -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. @@ -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. diff --git a/e2e_test/README.md b/e2e_test/README.md index e97b6cc73c358..198948e8eee15 100644 --- a/e2e_test/README.md +++ b/e2e_test/README.md @@ -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. > diff --git a/src/risedevtool/README.md b/src/risedevtool/README.md index 04dd2d82e32eb..7b41f951c7728 100644 --- a/src/risedevtool/README.md +++ b/src/risedevtool/README.md @@ -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`. >