UpstageAI/dataverse

📝 [Docs] - Docs seems to be misleading

Closed this issue · 3 comments

seonWKim commented

dataverse version checks

  • I have checked that the issue still exists on the latest versions of the dataverse.

Location of the documentation

Link: https://data-verse.gitbook.io/docs/lets-start/installation

image

Documentation problem

The title says that user should set SPARK_HOME, but the actual command is setting SPARK_PATH

Suggestion

Fix misleading documentation.

41ow1ives commented

Hello, @seonwoo960000 . Thank you for identifying the error! I truly appreciate it.
I've made the changes as below.

image

Thanks a lot again!

  • 👍2
seonWKim commented

@41ow1ives Thank you for the fast update. I'm a bit confused of below config

export SPARK_HOME=~/{YOUR-DOWNLOADED-SPARK-VERSION}

The environment variables seems to indicate the path of the home directory of spark but the {YOUR-DOWNLOADED-SPARK-VERSION} seems to indicate a version. At first I thought, we have to set the environment like below

export SPARK_HOME=~/3.5.1

Wouldn't it be better to change ~/{YOUR-DOWNLOADED-SPARK-VERSION} to {YOUR-SPARK-HOME-PATH} or other words that match the meaning of the env variable?

Btw, I'm setting my environment variable using below setting(I've installed apache spark using homebrew in my Mac)

export SPARK_PATH=$(brew --prefix apache-spark)
  • 👍1
  • ❤️1
41ow1ives commented

Thank you so much for your meticulous review! As you pointed out, that part could definitely be misleading. I fully agree with your suggestion. To be consistent with the previous mention of {YOUR-JAVA-DIRECTORY}, I will change it to {YOUR-SPARK-DIRECTORY}.

If you have any more ideas, suggestions, or improvements, please feel free to share them at any time! We are very open to even trivial comments! Thank you for taking an interest; I truly appreciate it. Have a great day 👍

  • ❤️1