[#789] Add getting started documentation #869
Conversation
Code Coverage Report
|
docs/getting-started.md
Outdated
| 4. Install the required Java Development Kits for Gravitino: | ||
|
|
||
| ```shell | ||
| sudo apt install openjdk-17-jdk-headless |
There was a problem hiding this comment.
After #868 is merged, we no longer need to manually install the JDK.
There was a problem hiding this comment.
This is not correct you do still need to install Java. I tried this out on latest main and got:
./gradlew build
ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation.
There was a problem hiding this comment.
So tested on a clean box and you still need one version of java installed. Updated guide to match that.
There was a problem hiding this comment.
OK, let me give it a try.
There was a problem hiding this comment.
@justinmclean
Maybe we should add some explanation that the minimum JDK version is JDK8, I see you only have the sentence
There was a problem hiding this comment.
- You need one version of JDK to start gradle (any version >= 8 is ok).
- You don't need to install JDK8 and 17 manually to build Gravitino, Gravitino gradle plugin will download them automatically if not installed.
- Currently, Gravitino can only work with JDK8, so if you want to run Gravitino please use JDK8.
- For the code format issue, please update the Gravitino code to the latest, I've fixed this issue.
There was a problem hiding this comment.
Lastest Gravitino is still failing due to #879
There was a problem hiding this comment.
From my testing, any version of the JDK is not correct. For instance, JDK21 currently fails. I've gone with JDK8 in these instructions as that is one that is needed. Is there anything else that needs to be updated?
There was a problem hiding this comment.
For instance, JDK21 currently fails
Can you show me your local environment? We need to fix it if so.
There was a problem hiding this comment.
See #906 I can reproduce it on ubuntu on AWS as well.
|
I think the doc should reflect the latest code, not still using 0.2.0. |
|
The doc does reflect the latest code. 0.2.0. is the last release we have, so it's mentioned in that content if you want to install it from a release. |
|
Can we merge this please? |
|
|
||
| ```shell | ||
| distribution/package/bin/gravitino.sh start | ||
| ``` |
There was a problem hiding this comment.
After starting the Gravitino server, suggest adding
- how to check GravitinoServer is started(like getting GravitinoServer version though curl)
- If GravitinoServer failed to start, where to check Gravitino logs
There was a problem hiding this comment.
That's covered by another ticket #790
What changes were proposed in this pull request?
Add documentation so people can easily get started with Gravinito.
Why are the changes needed?
To help people get started.
Fix: #789
Does this PR introduce any user-facing change?
N/A
How was this patch tested?
Doc follows doc style.