zkaoudi commented on code in PR #802:
URL: https://github.com/apache/wayang/pull/802#discussion_r3932134410
##########
wayang-docs/src/main/resources/getting_start/how_build/build_step.md:
##########
@@ -17,14 +17,69 @@ license: |
layout: default
title: "Step by Step Building Wayang"
previous:
- url: /
- title: previous
+ url: /getting_start/how_build/
+ title: How to Build Wayang
next:
- url: /
- title: next
-menus:
+ url: /getting_start/how_install/
+ title: How to Install Wayang
+menu:
build:
weight: 1
---
-Step by Step Building Wayang
+# Step by Step Building Wayang
+
+Follow these step-by-step instructions to compile, test, and package Apache
Wayang on your machine.
+
+---
+
+### Step 1: Clone the Git Repository
+```shell
+$ git clone https://github.com/apache/wayang.git
+$ cd wayang
+```
+
+---
+
+### Step 2: Verify System Prerequisites
+Ensure that your `JAVA_HOME` points to JDK 11 or 17 and that Java is in your
system PATH:
Review Comment:
same here
##########
wayang-docs/src/main/resources/index.md:
##########
Review Comment:
can you remove "incubating" and change the title to "A cross-platform data
processing system"
##########
wayang-docs/src/main/resources/index.md:
##########
Review Comment:
remove incubating
##########
wayang-docs/src/main/resources/getting_start/how_build/index.md:
##########
@@ -17,11 +17,63 @@ license: |
layout: default
title: "How to Build Wayang"
previous:
- url: /
- title: previous
+ url: /getting_start/
+ title: Getting Started
next:
- url: /
- title: next
+ url: /getting_start/how_build/build_step/
+ title: Step by Step Building Wayang
+menu:
+ getting_start:
+ weight: 0
+---
+
+# How to Build Apache Wayang
+
+This guide details the system prerequisites, environment setup, and Maven
commands required to build Apache Wayang from source.
+
+---
+
+## Requirements
+
+Before building Apache Wayang from source, ensure your environment meets the
following specifications:
+
+- **Java Development Kit (JDK)**: JDK 11 or JDK 17 (recommended: Eclipse
Temurin OpenJDK 17 or OpenJDK 11).
Review Comment:
here too and we do not recommend a specific distribution as far as i know.
##########
wayang-docs/src/main/resources/getting_start/index.md:
##########
@@ -18,10 +18,37 @@ layout: default
title: "Getting Started"
previous:
url: /
- title: previous
+ title: Read Me
next:
- url: /
- title: next
+ url: /getting_start/how_build/
+ title: How to Build Wayang
+menu:
+ header:
+ weight: 2
+---
+
+# Getting Started with Apache Wayang
+
+Welcome to Apache Wayang! This section guides you through the initial steps to
get up and running, build the system, understand core concepts, and assemble
your first cross-platform data processing application.
+
+---
+
+## Getting Started Sections
+
+1. **[How to Build Wayang]({% link getting_start/how_build/index.md %})**
+ Prerequisites, system requirements (Java 11/17, Scala 2.12, Maven), and
building Wayang from source using standard profiles.
Review Comment:
java 11 is not supported anymore
##########
wayang-docs/src/main/resources/index.md:
##########
Review Comment:
double-check versions here, plus there are newer platforms we support now
##########
wayang-docs/src/main/resources/index.md:
##########
Review Comment:
graphchi has been deprecated
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
