This is an automated email from the ASF dual-hosted git repository.
jshao pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new f7a4fd896 [#5175] docs: add playgound information in README (#5184)
f7a4fd896 is described below
commit f7a4fd8968f1a6d99c6daa6264fa8e3c3fc82f7e
Author: Shaofeng Shi <[email protected]>
AuthorDate: Mon Oct 21 12:09:03 2024 +0800
[#5175] docs: add playgound information in README (#5184)
### What changes were proposed in this pull request?
Some users suggest us to add the playgound link to Gravitino homepage as
well as code repository, so that a new user can quickly know there is
such a quick way to evaluate Gravitino.
### Why are the changes needed?
To improve the user experience, especially for new user.
Fix: #5175
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
Reviewed the doc in local.
---
README.md | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 94f1a1b9f..5feb69ed6 100644
--- a/README.md
+++ b/README.md
@@ -81,9 +81,13 @@ Please see [How to build Gravitino](docs/how-to-build.md)
for details on buildin
## Quick start
-### Configure and start the Apache Gravitino server
+### Use Gravitino playground
-If you already have a binary distribution package, go to the decompressed
package directory.
+This is the most recommended way: Gravitino provides a docker-compose based
playground to quickly experience the whole system together with other
components. Clone or download the [Gravitino playground
repository](https://github.com/apache/gravitino-playground) and then follow the
[README](https://github.com/apache/gravitino-playground/blob/main/README.md),
you will have all then.
+
+### Configure and start Gravitino server in local
+
+If you want to start Gravitino in your machine, download a binary package from
the [download page](https://gravitino.apache.org/downloads), and then
decompressed the package.
Before starting the Gravitino server, please configure the Gravitino server
configuration file. The
configuration file, `gravitino.conf`, is in the `conf` directory and follows
the standard property file format. You can modify the configuration within this
file.
