This is an automated email from the ASF dual-hosted git repository.
jongyoul pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/zeppelin-site.git
The following commit(s) were added to refs/heads/master by this push:
new eed69020c [ZEPPELIN-6036] update README.md (#7)
eed69020c is described below
commit eed69020c3fd2a7042ba5b741817357e1ebe60b9
Author: cherrie-k <80851202+cherri...@users.noreply.github.com>
AuthorDate: Sun Aug 4 12:23:58 2024 +0900
[ZEPPELIN-6036] update README.md (#7)
---
README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++------
1 file changed, 52 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 7164a205f..fa2e76bc0 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,40 @@
-## Zeppelin project website
+## Zeppelin Project Website
This readme will walk you through building the Zeppelin website
-## Requirement
-- Docker
+## Requirements
+- **Docker**: Ensure Docker is installed and running on your machine.
+- **Ruby**: Check that your Ruby version is compatible with all gems listed in
the Gemfile.
## Develop website
+
+Follow these steps to set up and run the development environment:
+
+**1. Clone the Repository**
+```bash
+$ git clone <repository-url>
+$ cd <repository-directory>
+```
+
+**2. Ensure Docker is Running**:
+
+Make sure Docker is installed and running on your machine. Below is an example
how.
+```bash
+$ open -a Docker
+```
+
+**3. Build the Docker Image**:
+```bash
+$ ./zeppelin-site.sh --build-image
+```
+
+**4. Run the Development Server**:
```bash
-$ ./run-dev.sh
+$ ./zeppelin-site.sh
```
-- Open http://127.0.0.1:4000
+
+**5. Open the Website**:
+
+Open your web browser and go to [http://localhost:4000](http://localhost:4000)
or [http://127.0.0.1:4000](http://127.0.0.1:4000).
### Adding a new page
@@ -17,6 +43,26 @@ $ rake page name="new-page.md"
```
## Build website
+
+Follow these steps to build the production site:
+
+**1. Build the Production Site**:
```bash
-$ ./build-dev.sh
+$ ./zeppelin-site.sh --build-dist
```
+
+**2. The built site will be available in the _site directory.**
+
+
+## Troubleshooting and Notes:
+Ensure all dependencies are correctly listed and installed.
+
+If you encounter issues, you may need to run:
+```bash
+$ docker run --rm -it -v "$(pwd):/app" zeppelin-site-dev:latest /bin/bash
+$ bundle install
+```
+
+Dockerfile and Gemfile Adjustments:
+- Updates to the Dockerfile or Gemfile may include necessary system
dependencies for gems like Nokogiri.
+- Refer to these files for specific details.
\ No newline at end of file
