This is an automated email from the ASF dual-hosted git repository.
zjffdu pushed a commit to branch branch-0.9
in repository https://gitbox.apache.org/repos/asf/zeppelin.git
The following commit(s) were added to refs/heads/branch-0.9 by this push:
new d737989 [ZEPPELIN-5248] - Add local docker-compose support and
updated readme instructions
d737989 is described below
commit d7379896baf9f38ae7ef9064d8241e3611d6dab2
Author: OmriK <[email protected]>
AuthorDate: Fri Feb 12 09:17:02 2021 +0200
[ZEPPELIN-5248] - Add local docker-compose support and updated readme
instructions
### What is this PR for?
To make it easier for new contributors to build and test documentation
changes, will add support to build and serve locally using docker.
### What type of PR is it?
Improvement
### Todos
* [ ] - Task
### What is the Jira issue?
https://issues.apache.org/jira/browse/ZEPPELIN-5248
### How should this be tested?
* Automated CI
* Can be tested by following updated README instructions to run
`docker-compose up` locally
*
### Screenshots (if appropriate)
### Questions:
* Does the licenses files need update? no
* Is there breaking changes for older versions? no
* Does this needs documentation? no
Author: OmriK <[email protected]>
Closes #4054 from
omrisk/ZEPPELIN-5248-docker-support-for-local-documentation and squashes the
following commits:
cbb906199 [OmriK] Convert to single command docker run, remove
docker-compose.yml
d4cf00309 [OmriK] Add local docker-compose support and updated readme
instructions
(cherry picked from commit 9259620dea232d0abecbf2815f7bed47d19cda61)
Signed-off-by: Jeff Zhang <[email protected]>
---
docs/README.md | 20 ++++++++++++++++++--
1 file changed, 18 insertions(+), 2 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 62ef8a8..7ca822e 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -25,16 +25,32 @@ On OS X 10.9, you may need to do
xcode-select --install
```
+**Docker**
+
+Local docker environments are also supported and have been tested using:
+* [Docker version 20.10.2](https://docs.docker.com/get-docker/)
+
## Run website locally
If you don't want to encounter ugly rendered pages, run the documentation site
in your local environment first.
-In `$ZEPPELIN_HOME/docs`,
+In `$ZEPPELIN_HOME/docs`, run one of the desired commands:
+**Run locally**
```
bundle exec jekyll serve --watch
```
-Using the above command, Jekyll will start a web server at
`http://localhost:4000` and watch the `/docs` directory to update.
+**Run locally using docker**
+```
+docker run --rm -it \
+ -v $PWD:/docs \
+ -w /docs \
+ -p '4000:4000' \
+ ruby:2.0.0 \
+ bash -c "bundle install && bundle exec jekyll serve --watch"
+```
+
+Using the above command, Jekyll will start a web server at
`http://localhost:4000` and watch the `/docs` directory for updates.
