This is an automated email from the ASF dual-hosted git repository.
pdallig pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/zeppelin.git
The following commit(s) were added to refs/heads/master by this push:
new 526eb15b87 [ZEPPELIN-6198] Fix multiple typos in documentation
markdown files
526eb15b87 is described below
commit 526eb15b8732909ab994adba76e0c3e33bfa001c
Author: 강현욱 <43662405+hyu...@users.noreply.github.com>
AuthorDate: Fri Jun 13 13:56:58 2025 +0900
[ZEPPELIN-6198] Fix multiple typos in documentation markdown files
### What is this PR for?
This PR fixes multiple typos found in markdown documentation files.
| File | Incorrect
Words | Correction(s) |
|------------------------------------------------------------|----------------------------------------|----------------------------------|
| `STYLE.md` | overridden
| override |
| `docs/usage/rest_api/notebook.md` | gernerates
| generates |
| `docs/usage/rest_api/helium.md` | reponse
| response |
| `docs/usage/other_features/cron_scheduler.md` | are binded
| are bound |
| `docs/usage/display_system/basic.md` | wich
| which |
| `docs/setup/deployment/virtual_machine.md` | fowarding
| forwarding |
| `docs/quickstart/kubernetes.md` | persiste,
overrided | persist, overridden |
| `docs/quickstart/install.md` | volumn
| volume |
| `docs/quickstart/explore_ui.md` | shorcuts,
authentification | shortcuts, authentication |
| `docs/interpreter/python.md` | enviornment
| environment |
| `docs/interpreter/neo4j.md` | dafault
| default |
| `docs/interpreter/mahout.md` | follwoing,
coppied | following, copied |
| `docs/interpreter/livy.md` | sugguest,
avalible, formst | suggest, available, format |
| `docs/interpreter/groovy.md` | usefull
| useful |
| `docs/development/helium/writing_application.md` | Resouce,
possiblities | Resource, possibilities |
| `docs/development/contribution/how_to_contribute_code.md` | repro
| repo |
| `docs/assets/themes/zeppelin/js/search.js` | —
| (deleted) |
### What type of PR is it?
Documentation
### Todos
* [x] - Fix all identified typos listed in the linked issue.
### What is the Jira issue?
* Jira - https://issues.apache.org/jira/browse/ZEPPELIN-6198
### How should this be tested?
* N/A
### Screenshots (if appropriate)
* N/A
### Questions:
* Does the license files need to update? No.
* Is there breaking changes for older versions? No.
* Does this needs documentation? No.
Closes #4943 from hyunw9/fix-multiple-typo-in-docs.
Signed-off-by: Philipp Dallig <philipp.dal...@gmail.com>
---
STYLE.md | 2 +-
docs/assets/themes/zeppelin/js/search.js | 3 ---
docs/development/contribution/how_to_contribute_code.md | 2 +-
docs/development/helium/writing_application.md | 4 ++--
docs/interpreter/groovy.md | 2 +-
docs/interpreter/livy.md | 6 +++---
docs/interpreter/mahout.md | 4 ++--
docs/interpreter/neo4j.md | 2 +-
docs/interpreter/python.md | 2 +-
docs/quickstart/explore_ui.md | 4 ++--
docs/quickstart/install.md | 2 +-
docs/quickstart/kubernetes.md | 4 ++--
docs/setup/deployment/virtual_machine.md | 2 +-
docs/usage/display_system/basic.md | 2 +-
docs/usage/other_features/cron_scheduler.md | 2 +-
docs/usage/rest_api/helium.md | 4 ++--
docs/usage/rest_api/notebook.md | 2 +-
17 files changed, 23 insertions(+), 26 deletions(-)
diff --git a/STYLE.md b/STYLE.md
index b0a5f2a084..94265e0b73 100644
--- a/STYLE.md
+++ b/STYLE.md
@@ -18,7 +18,7 @@ Call setTheme on the editor with the theme path/name.
#### Style for Markdown Code Blocks
Highlight.js parses and converts <pre><code> blocks from markdown
parser into keywords and language syntax with proper styles. It also attempts
to infer the best fitting language if it is not provided. The visual style can
be changed by simply including the desired
[stylesheet](https://github.com/components/highlightjs/tree/master/styles) into
app/index.html. See the next section on build.
-Note that code block background color is overriden in app/styles/notebook.css
(look for .paragraph .tableDisplay .hljs).
+Note that code block background color is overridden in app/styles/notebook.css
(look for .paragraph .tableDisplay .hljs).
#### Build changes
bower.json
diff --git a/docs/assets/themes/zeppelin/js/search.js
b/docs/assets/themes/zeppelin/js/search.js
index 407c1f9258..33571c769e 100644
--- a/docs/assets/themes/zeppelin/js/search.js
+++ b/docs/assets/themes/zeppelin/js/search.js
@@ -1,6 +1,3 @@
----
-
----
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
diff --git a/docs/development/contribution/how_to_contribute_code.md
b/docs/development/contribution/how_to_contribute_code.md
index f806841cb6..5cdf024710 100644
--- a/docs/development/contribution/how_to_contribute_code.md
+++ b/docs/development/contribution/how_to_contribute_code.md
@@ -107,7 +107,7 @@ HADOOP_HOME=YOUR_HADOOP_HOME JAVA_HOME=YOUR_JAVA_HOME \
./mvnw clean install -DskipTests
```
-in your zeppelin root directory, otherwise your server build will fail to find
the required dependencies in the local repro.
+in your zeppelin root directory, otherwise your server build will fail to find
the required dependencies in the local repo.
or use daemon script
diff --git a/docs/development/helium/writing_application.md
b/docs/development/helium/writing_application.md
index d128671e23..0fa775dd6e 100644
--- a/docs/development/helium/writing_application.md
+++ b/docs/development/helium/writing_application.md
@@ -25,7 +25,7 @@ limitations under the License.
## What is Apache Zeppelin Application
-Apache Zeppelin Application is a package that runs on Interpreter process and
displays it's output inside of the notebook. While application runs on
Interpreter process, it's able to access resources provided by Interpreter
through ResourcePool. Output is always rendered by AngularDisplaySystem.
Therefore application provides all the possiblities of making interactive
graphical application that uses data and processing power of any Interpreter.
+Apache Zeppelin Application is a package that runs on Interpreter process and
displays it's output inside of the notebook. While application runs on
Interpreter process, it's able to access resources provided by Interpreter
through ResourcePool. Output is always rendered by AngularDisplaySystem.
Therefore application provides all the possibilities of making interactive
graphical application that uses data and processing power of any Interpreter.
## Make your own Application
@@ -143,7 +143,7 @@ Entry point. Class that extends
`org.apache.zeppelin.helium.Application`
Two dimensional array that defines required resources by name or by className.
Helium Application launcher will compare resources in the ResourcePool with the
information in this field and suggest application only when all required
resources are available in the ResourcePool.
-Resouce name is a string which will be compared with the name of objects in
the ResourcePool. className is a string with ":" prepended, which will be
compared with className of the objects in the ResourcePool.
+Resource name is a string which will be compared with the name of objects in
the ResourcePool. className is a string with ":" prepended, which will be
compared with className of the objects in the ResourcePool.
Application may require two or more resources. Required resources can be
listed inside of the json array. For example, if the application requires
object "name1", "name2" and "className1" type of object to run, resources field
can be
diff --git a/docs/interpreter/groovy.md b/docs/interpreter/groovy.md
index 679b5bcce6..4b7bd2ba74 100644
--- a/docs/interpreter/groovy.md
+++ b/docs/interpreter/groovy.md
@@ -106,7 +106,7 @@ g.table(
* `groovy.xml.MarkupBuilder g.html()`
Starts or continues rendering of `%angular` to output and returns
[groovy.xml.MarkupBuilder](http://groovy-lang.org/processing-xml.html#_markupbuilder)
- MarkupBuilder is usefull to generate html (xml)
+ MarkupBuilder is useful to generate html (xml)
* `void g.table(obj)`
diff --git a/docs/interpreter/livy.md b/docs/interpreter/livy.md
index a7b13a1727..8b0024fab6 100644
--- a/docs/interpreter/livy.md
+++ b/docs/interpreter/livy.md
@@ -182,7 +182,7 @@ Example: `spark.driver.memory` to `livy.spark.driver.memory`
</tr>
</table>
-**We remove livy.spark.master in zeppelin-0.7. Because we sugguest user to use
livy 0.3 in zeppelin-0.7. And livy 0.3 don't allow to specify
livy.spark.master, it enfornce yarn-cluster mode.**
+**We remove livy.spark.master in zeppelin-0.7. Because we suggest user to use
livy 0.3 in zeppelin-0.7. And livy 0.3 don't allow to specify
livy.spark.master, it enfornce yarn-cluster mode.**
## Adding External libraries
You can load dynamic library to livy interpreter by set
`livy.spark.jars.packages` property to comma-separated list of maven
coordinates of jars to include on the driver and executor classpaths. The
format for the coordinates should be groupId:artifactId:version.
@@ -238,14 +238,14 @@ i.e. sends extra parameter for creating and running a
session ("proxyUser": "${l
This is particularly useful when multi users are sharing a Notebook server.
## Apply Zeppelin Dynamic Forms
-You can leverage [Zeppelin Dynamic Form](../usage/dynamic_form/intro.html).
Form templates is only avalible for livy sql interpreter.
+You can leverage [Zeppelin Dynamic Form](../usage/dynamic_form/intro.html).
Form templates is only available for livy sql interpreter.
```sql
%livy.sql
select * from products where ${product_id=1}
```
-And creating dynamic formst programmatically is not feasible in livy
interpreter, because ZeppelinContext is not available in livy interpreter.
+And creating dynamic format programmatically is not feasible in livy
interpreter, because ZeppelinContext is not available in livy interpreter.
## Shared SparkContext
Starting from livy 0.5 which is supported by Zeppelin 0.8.0, SparkContext is
shared between scala, python, r and sql.
diff --git a/docs/interpreter/mahout.md b/docs/interpreter/mahout.md
index 0b1d5292f8..c07edc6899 100644
--- a/docs/interpreter/mahout.md
+++ b/docs/interpreter/mahout.md
@@ -75,7 +75,7 @@ The `add_mahout.py` script contains several command line
arguments for advanced
__NOTE 1:__ Apache Mahout at this time only supports Spark 1.5 and Spark 1.6
and Scala 2.10. If the user is using another version of Spark (e.g. 2.0), the
`%sparkMahout` will likely not work. The `%flinkMahout` interpreter will still
work and the user is encouraged to develop with that engine as the code can be
ported via copy and paste, as is evidenced by the tutorial notebook.
-__NOTE 2:__ If using Apache Flink in cluster mode, the following libraries
will also need to be coppied to `${FLINK_HOME}/lib`
+__NOTE 2:__ If using Apache Flink in cluster mode, the following libraries
will also need to be copied to `${FLINK_HOME}/lib`
- mahout-math-0.12.2.jar
- mahout-math-scala_2.10-0.12.2.jar
- mahout-flink_2.10-0.12.2.jar
@@ -173,7 +173,7 @@ z.put("foo", myVal)
val myFetchedVal = z.get("foo")
```
-To add this functionality to a Flink based interpreter we declare the follwoing
+To add this functionality to a Flink based interpreter we declare the following
```scala
%flinkMahout
diff --git a/docs/interpreter/neo4j.md b/docs/interpreter/neo4j.md
index a36e42a0ae..436532ff56 100644
--- a/docs/interpreter/neo4j.md
+++ b/docs/interpreter/neo4j.md
@@ -47,7 +47,7 @@ The Neo4j Interpreter supports all Neo4j versions since v3
via the official [Neo
<tr>
<td>neo4j.database</td>
<td></td>
- <td>The neo4j target database, if empty use the dafault db.</td>
+ <td>The neo4j target database, if empty use the default db.</td>
</tr>
<tr>
<td>neo4j.multi.statement</td>
diff --git a/docs/interpreter/python.md b/docs/interpreter/python.md
index 07e37a7b67..93567dc211 100644
--- a/docs/interpreter/python.md
+++ b/docs/interpreter/python.md
@@ -530,7 +530,7 @@ The interpreter can use all modules already installed (with
pip, easy_install...
%python.conda env list
```
-- create a conda enviornment:
+- create a conda environment:
```
%python.conda create --name [ENV NAME]
diff --git a/docs/quickstart/explore_ui.md b/docs/quickstart/explore_ui.md
index 5a466385e8..074d1a8c0a 100644
--- a/docs/quickstart/explore_ui.md
+++ b/docs/quickstart/explore_ui.md
@@ -84,7 +84,7 @@ The `Notebook` menu proposes almost the same features as the
note management sec
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/notebook_menu.png"
width="170px" />
### Settings
-This menu gives you access to settings and displays information about
Zeppelin. User name is set to `anonymous` if you use default shiro
configuration. If you want to set up authentification, see [Shiro
Authentication](../setup/security/shiro_authentication.html).
+This menu gives you access to settings and displays information about
Zeppelin. User name is set to `anonymous` if you use default shiro
configuration. If you want to set up authentication, see [Shiro
Authentication](../setup/security/shiro_authentication.html).
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/settings_menu.png"
width="170px" />
@@ -178,7 +178,7 @@ In the middle of the toolbar you can find the command
buttons:
On the right of the note tool bar you can find configuration icons:
-* display all the keyboard shorcuts
+* display all the keyboard shortcuts
* configure the interpreters binding to the current note
* configure the note permissions
* switch the node display mode between `default`, `simple` and `report`
diff --git a/docs/quickstart/install.md b/docs/quickstart/install.md
index c4e57692aa..a8dc832a4b 100644
--- a/docs/quickstart/install.md
+++ b/docs/quickstart/install.md
@@ -101,7 +101,7 @@ docker run -u $(id -u) -p 8080:8080 --rm -v $PWD/logs:/logs
-v $PWD/notebook:/no
`-u $(id -u)` is to make sure you have the permission to write logs and
notebooks.
For many interpreters, they require other dependencies, e.g. Spark interpreter
requires Spark binary distribution
-and Flink interpreter requires Flink binary distribution. You can also mount
them via docker volumn. e.g.
+and Flink interpreter requires Flink binary distribution. You can also mount
them via docker volume. e.g.
```bash
docker run -u $(id -u) -p 8080:8080 --rm -v /mnt/disk1/notebook:/notebook \
diff --git a/docs/quickstart/kubernetes.md b/docs/quickstart/kubernetes.md
index f60003f40a..e963632ddd 100644
--- a/docs/quickstart/kubernetes.md
+++ b/docs/quickstart/kubernetes.md
@@ -231,7 +231,7 @@ and all interpreter properties are accessible inside the
templates.
When interpreter group is `spark`, Zeppelin sets necessary spark configuration
automatically to use Spark on Kubernetes.
It uses client mode, so Spark interpreter Pod works as a Spark driver, spark
executors are launched in separate Pods.
-This auto configuration can be overrided by manually setting `spark.master`
property of Spark interpreter.
+This auto configuration can be overridden by manually setting `spark.master`
property of Spark interpreter.
### Accessing Spark UI (or Service running in interpreter Pod)
@@ -266,7 +266,7 @@ If you like to use your custom domain
## Persist /notebook and /conf directory
Notebook and configurations are not persisted by default. Please configure
volume and update `k8s/zeppelin-server.yaml`
-to use the volume to persiste /notebook and /conf directory if necessary.
+to use the volume to persist /notebook and /conf directory if necessary.
## Customization
diff --git a/docs/setup/deployment/virtual_machine.md
b/docs/setup/deployment/virtual_machine.md
index 0578b9caa7..4eb3ae92ce 100644
--- a/docs/setup/deployment/virtual_machine.md
+++ b/docs/setup/deployment/virtual_machine.md
@@ -118,7 +118,7 @@ If you [turned off port
forwarding](#tweaking-the-virtual-machine) in the `Vagra
## Tweaking the Virtual Machine
-If you plan to run this virtual machine along side other Vagrant images, you
may wish to bind the virtual machine to a specific IP address, and not use port
fowarding from your local host.
+If you plan to run this virtual machine along side other Vagrant images, you
may wish to bind the virtual machine to a specific IP address, and not use port
forwarding from your local host.
Comment out the `forward_port` line, and uncomment the `private_network` line
in Vagrantfile. The subnet that works best for your local network will vary so
adjust `192.168.*.*` accordingly.
diff --git a/docs/usage/display_system/basic.md
b/docs/usage/display_system/basic.md
index f0a4dde965..01d46297fc 100644
--- a/docs/usage/display_system/basic.md
+++ b/docs/usage/display_system/basic.md
@@ -108,7 +108,7 @@ The new NETWORK visualization is based on json with the
following params:
* "label": the main type of the edge;
* "data": the data attached to the edge;
* "labels": a map (K, V) where K is the node label and V is the color of the
node;
-* "directed": (true/false, default false) wich tells if is directed graph or
not;
+* "directed": (true/false, default false) which tells if is directed graph or
not;
* "types": a *distinct* list of the edge types of the graph
If you click on a node or edge on the bottom of the paragraph you find a list
of entity properties
diff --git a/docs/usage/other_features/cron_scheduler.md
b/docs/usage/other_features/cron_scheduler.md
index 36958e6fe8..d4bd3c78c2 100644
--- a/docs/usage/other_features/cron_scheduler.md
+++ b/docs/usage/other_features/cron_scheduler.md
@@ -47,7 +47,7 @@ You can set the cron executing user by filling in this form
and press the enter
### After execution stop the interpreter
-When this checkbox is set to "on", the interpreters which are binded to the
notebook are stopped automatically after the cron execution. This feature is
useful if you want to release the interpreter resources after the cron
execution.
+When this checkbox is set to "on", the interpreters which are bound to the
notebook are stopped automatically after the cron execution. This feature is
useful if you want to release the interpreter resources after the cron
execution.
> **Note**: A cron execution is skipped if one of the paragraphs is in a state
> of `RUNNING` or `PENDING` no matter whether it is executed automatically
> (i.e. by the cron scheduler) or manually by a user opening this notebook.
diff --git a/docs/usage/rest_api/helium.md b/docs/usage/rest_api/helium.md
index 47bff23b7e..35db5858e7 100644
--- a/docs/usage/rest_api/helium.md
+++ b/docs/usage/rest_api/helium.md
@@ -316,12 +316,12 @@ If you work with Apache Zeppelin and find a need for an
additional REST API, ple
</tr>
<tr>
<td>Success code</td>
- <td>200 reponse body is executable javascript</td>
+ <td>200 response body is executable javascript</td>
</tr>
<tr>
<td>Fail code</td>
<td>
- 200 reponse body is error message string starts with ERROR:<br/>
+ 200 response body is error message string starts with ERROR:<br/>
</td>
</tr>
</table>
diff --git a/docs/usage/rest_api/notebook.md b/docs/usage/rest_api/notebook.md
index b669213206..0f858024f8 100644
--- a/docs/usage/rest_api/notebook.md
+++ b/docs/usage/rest_api/notebook.md
@@ -448,7 +448,7 @@ Notebooks REST API supports the following operations: List,
Create, Get, Delete,
<col width="200">
<tr>
<td>Description</td>
- <td>This ```GET``` method exports a note by the given id and gernerates
a JSON
+ <td>This ```GET``` method exports a note by the given id and generates a
JSON
</td>
</tr>
<tr>
