flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From se...@apache.org
Subject [1/2] git commit: [FLINK-1050] Windows local setup documentation: added note for java being in %PATH% variable, headers, and missing link label
Date Wed, 20 Aug 2014 11:47:29 GMT
Repository: incubator-flink
Updated Branches:
  refs/heads/master e8f2e9d0e -> 6c48063ad

[FLINK-1050] Windows local setup documentation: added note for java being in %PATH% variable,
headers, and missing link label

This closes #95

Project: http://git-wip-us.apache.org/repos/asf/incubator-flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-flink/commit/91a52a14
Tree: http://git-wip-us.apache.org/repos/asf/incubator-flink/tree/91a52a14
Diff: http://git-wip-us.apache.org/repos/asf/incubator-flink/diff/91a52a14

Branch: refs/heads/master
Commit: 91a52a140a11f8a917dd735b384b61387bbf47e6
Parents: e8f2e9d
Author: Fabian Hueske <fhueske@apache.org>
Authored: Thu Aug 14 18:00:57 2014 +0200
Committer: Stephan Ewen <sewen@apache.org>
Committed: Wed Aug 20 13:32:53 2014 +0200

 docs/local_setup.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/docs/local_setup.md b/docs/local_setup.md
index dd8ffe5..d12401b 100644
--- a/docs/local_setup.md
+++ b/docs/local_setup.md
@@ -56,12 +56,17 @@ INFO ... - Starting web info server for JobManager on port 8081
 The JobManager will also start a web frontend on port 8081, which you can check with your
browser at `http://localhost:8081`.
+<section id="windows">
 # Flink on Windows
 If you want to run Flink on Windows you need to download, unpack and configure the Flink
archive as mentioned above. After that you can either use the **Windows Batch** file (`.bat`)
or use **Cygwin**  to run the Flink Jobmanager.
+### Starting with Windows Batch Files
 To start Flink in local mode from the *Windows Batch*, open the command window, navigate
to the `bin/` directory of Flink and run `start-local.bat`.
+Note: The ``bin`` folder of your Java Runtime Environment must be included in Window's ``%PATH%``
variable. Follow this [guide](http://www.java.com/en/download/help/path.xml) to add Java to
the ``%PATH%`` variable.
 $ cd flink
 $ cd bin
@@ -72,6 +77,8 @@ Do not close this batch window. Stop job manager by pressing Ctrl+C.
 After that, you need to open a second terminal to run jobs using `flink.bat`.
+### Starting with Cygwin and Unix Scripts
 With *Cygwin* you need to start the Cygwin Terminal, navigate to your Flink directory and
run the `start-local.sh` script:
@@ -80,6 +87,8 @@ $ bin/start-local.sh
 Starting Nephele job manager
+### Installing Flink from Git
 If you are installing Flink from the git repository and you are using the Windows git shell,
Cygwin can produce a failure similiar to this one:

View raw message