Remove unnecessary python topic. Style changes to quickstart.#13647
Remove unnecessary python topic. Style changes to quickstart.#13647vtlim merged 9 commits intoapache:masterfrom
Conversation
techdocsmith
force-pushed
the
clean-quickstart
branch
from
9e1a56f to
bbfd5bd
Compare
vtlim
left a comment
vtlim
left a comment
There was a problem hiding this comment.
Worthwhile improvements! Suggested a few changes.
Prerequisites
Co-authored-by: Victoria Lim <vtlim@users.noreply.github.com>
docs/tutorials/index.md
Outdated
|
|
||
| In addition, Druid includes several [bundled non-automatic profiles](../operations/single-server.md) for a range of machine sizes. These range from nano (1 CPU, 4GiB RAM) to x-large (64 CPU, 512GiB RAM). | ||
| We won't use those here, but for more information, see [Single server deployment](../operations/single-server.md). For additional information on deploying Druid services across clustered machines, see [Clustered deployment](./cluster.md). | ||
| In addition, Druid includes several [bundled static profiles](../operations/single-server.md) for a range of machine sizes. These range from nano (1 CPU, 4 GiB RAM) to x-large (64 CPU, 512 GiB RAM). |
There was a problem hiding this comment.
Perhaps add, "Many people use the micro-quickstart profile when learning Druid." That way, folks won't have to guess which one to pick to get started.
There was a problem hiding this comment.
You don't need to pick one. /bin/start-druid should theoretically work without having to specify.
docs/tutorials/index.md
Outdated
| > Druid relies on the environment variables `JAVA_HOME` or `DRUID_JAVA_HOME` to find Java on the machine. You can set | ||
| `DRUID_JAVA_HOME` if there is more than one instance of Java. To verify Java requirements for your environment, run the | ||
| `bin/verify-java` script. | ||
| You must set either the `JAVA_HOME` or `DRUID_JAVA_HOME` environment variable for Druid to find Java on the machine. If there is more than one version of Java installed, set |
There was a problem hiding this comment.
Is this true? I suspect we can also infer the location from the java command. For example, on my machine, I have neither of the above env vars set, but java is on the path.
There was a problem hiding this comment.
Suggestion:
Java must be available. Either it is on your path, or set one of the
JAVA_HOMEorDRUID_JAVA_HOMEenvironment variables.
docs/tutorials/index.md
Outdated
|
|
||
| All persistent state, such as the cluster metadata store and segments for the services, are kept in the `var` directory under | ||
| the Druid root directory, apache-druid-{{DRUIDVERSION}}. Each service writes to a log file under `var/sv`. | ||
| It may use up to 80% of the total available system memory. |
docs/tutorials/index.md
Outdated
| To explicitly set the total memory available to Druid, pass a value for the memory parameter. For example, `./bin/start-druid -m 16g`. | ||
|
|
||
| Druid stores all persistent state data, such as the cluster metadata store and data segments, in `apache-druid-{{DRUIDVERSION}}/var`. | ||
| Each service writes to a log file under `var/sv`. |
There was a problem hiding this comment.
Did we change that again? In my latest build, logs go to $DRUID_HOME/log.
(See how smooth it is to use $DRUID_HOME instead of apache-druid-{{DRUIDVERSION}}?
Also, note that here we are prefixing var with apache-druid-{{DRUIDVERSION}}, where as above we just referenced bin without a prefix.
docs/tutorials/index.md
Outdated
| ## Open the web console | ||
|
|
||
| After the Druid services finish startup, open the [web console](../operations/web-console.md) at [http://localhost:8888](http://localhost:8888). | ||
| After the Druid services launch, open the [web console](../operations/web-console.md) at [http://localhost:8888](http://localhost:8888). |
There was a problem hiding this comment.
Actually, it takes some time for the services to become ready after they "launch." Maybe:
After starting the Druid services, open ...
Change instances of 16 GiB to 6 GiB
paul-rogers
left a comment
paul-rogers
left a comment
There was a problem hiding this comment.
If we can fix the Java wording, the rest looks good to go.
Note on the Python 2 thing: as we add notebooks, we'll depend on Python 3. It will be fiddly to say that Druid can run with Python 2, but the notebooks need Python 3. Maybe we can say:
Python 2 or Python 3 (preferred)
5 participants
This PR has: