You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by zj...@apache.org on 2021/02/19 23:10:56 UTC

[zeppelin] branch master updated: [ZEPPELIN-5223] - K8s+docker document format is not correct

This is an automated email from the ASF dual-hosted git repository.

zjffdu 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 5642b52  [ZEPPELIN-5223] - K8s+docker document format is not correct
5642b52 is described below

commit 5642b52077f14529c48d1e685d83fcae86c89388
Author: OmriK <om...@dynamicyield.com>
AuthorDate: Thu Feb 11 13:59:14 2021 +0200

    [ZEPPELIN-5223] - K8s+docker document format is not correct
    
    Added formatting (to avoid escaping each `_` occurrence, I couldn't find a style guide for documentation or other examples that would suggest another method.
    I noticed this also happens in the `docker.md` so I fixed that as well
    
    Author: OmriK <om...@dynamicyield.com>
    
    Closes #4053 from omrisk/ZEPPELIN-5223-k8s-doc-format and squashes the following commits:
    
    55f58464f [OmriK] Fix docs README.md typo
    a751a98e6 [OmriK] Fix markdown formating for quickstart docs
---
 docs/README.md                |  2 +-
 docs/quickstart/docker.md     |  4 ++--
 docs/quickstart/kubernetes.md | 12 ++++++------
 3 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/docs/README.md b/docs/README.md
index c1fee030..62ef8a8 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -26,7 +26,7 @@ xcode-select --install
 ```
 
 ## Run website locally
-If you don't want to encounter uglily rendered pages, run the documentation site in your local first.
+If you don't want to encounter ugly rendered pages, run the documentation site in your local environment first.
 
 In `$ZEPPELIN_HOME/docs`,
 
diff --git a/docs/quickstart/docker.md b/docs/quickstart/docker.md
index dca9a89..a336202 100644
--- a/docs/quickstart/docker.md
+++ b/docs/quickstart/docker.md
@@ -205,5 +205,5 @@ Zeppelin can run locally (such as inside your IDE in debug mode) and able to run
 
 | Configuration variable | Value | Description |
 | ----- | ----- | ----- |
-| ZEPPELIN_RUN_MODE | docker | Make Zeppelin run interpreter on Docker |
-| ZEPPELIN_DOCKER_CONTAINER_IMAGE | <image>:<version> | Zeppelin interpreter docker image to use |
+| `ZEPPELIN_RUN_MODE` | `docker` | Make Zeppelin run interpreter on Docker |
+| `ZEPPELIN_DOCKER_CONTAINER_IMAGE` | `<image>:<version>` | Zeppelin interpreter docker image to use |
diff --git a/docs/quickstart/kubernetes.md b/docs/quickstart/kubernetes.md
index 2cfbbca..8df27a4 100644
--- a/docs/quickstart/kubernetes.md
+++ b/docs/quickstart/kubernetes.md
@@ -260,10 +260,10 @@ Zeppelin can run locally (such as inside your IDE in debug mode) and able to run
 
 | Environment variable | Value | Description |
 | ----- | ----- | ----- |
-| ZEPPELIN_RUN_MODE | k8s | Make Zeppelin run interpreter on Kubernetes |
-| ZEPPELIN_K8S_PORTFORWARD | true | Enable port forwarding from local Zeppelin instance to Interpreters running on Kubernetes |
-| ZEPPELIN_K8S_CONTAINER_IMAGE | <image>:<version> | Zeppelin interpreter docker image to use |
-| ZEPPELIN_K8S_SPARK_CONTAINER_IMAGE | <image>:<version> | Spark docker image to use |
-| ZEPPELIN_K8S_NAMESPACE | <k8s namespace> | Kubernetes namespace  to use |
-| KUBERNETES_AUTH_TOKEN | <token> | Kubernetes auth token to create resources |
+| `ZEPPELIN_RUN_MODE` | `k8s` | Make Zeppelin run interpreter on Kubernetes |
+| `ZEPPELIN_K8S_PORTFORWARD` | `true` | Enable port forwarding from local Zeppelin instance to Interpreters running on Kubernetes |
+| `ZEPPELIN_K8S_CONTAINER_IMAGE` | `<image>:<version>` | Zeppelin interpreter docker image to use |
+| `ZEPPELIN_K8S_SPARK_CONTAINER_IMAGE` | `<image>:<version>` | Spark docker image to use |
+| `ZEPPELIN_K8S_NAMESPACE` | `<k8s namespace>` | Kubernetes namespace  to use |
+| `KUBERNETES_AUTH_TOKEN` | `<token>` | Kubernetes auth token to create resources |