Repository: flink Updated Branches: refs/heads/master 949ff8dae -> 2859f59f8
[FLINK-2095][docs] Added missing screenshots to webclient documentation This closes #976 Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/2859f59f Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/2859f59f Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/2859f59f Branch: refs/heads/master Commit: 2859f59f84aae46791b51493f8777679de496a86 Parents: 949ff8d Author: mjsax <mj...@informatik.hu-berlin.de> Authored: Mon Aug 3 22:04:35 2015 +0200 Committer: Fabian Hueske <fhue...@apache.org> Committed: Tue Aug 4 00:26:36 2015 +0200 ---------------------------------------------------------------------- docs/apis/web_client.md | 55 +++++++++++++++++++++++++++++--------------- 1 file changed, 37 insertions(+), 18 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/2859f59f/docs/apis/web_client.md ---------------------------------------------------------------------- diff --git a/docs/apis/web_client.md b/docs/apis/web_client.md index 8e3c84a..4749d90 100644 --- a/docs/apis/web_client.md +++ b/docs/apis/web_client.md @@ -46,16 +46,27 @@ The web interface provides two views: ### Job View -The interface starts serving the job view. - -You can **upload** a Flink program as a jar file. To **execute** an uploaded program: - -* select it from the job list on the left, -* enter (optional) execution options in the *"Flink Options"* field (bottom left), -* enter (optional) program arguments in the *"Program Arguments"* field (bottom left), and -* click on the *"Run Job"* button (bottom right). - -If the *âShow optimizer planâ* option is enabled (default), the *plan view* is display next, otherwise the job is directly submitted to the JobManager for execution. +<div class="row"> + <div class="col-md-4"> + The interface starts serving the job view. <br> + <br> + You can <strong>upload</strong> a Flink program as a jar file. <br> + <br> + To <strong>execute</strong> an uploaded program: + <ul> + <li>select it from the job list on the left,</li> + <li>enter (optional) execution options in the <em>"Flink Options"</em> field (bottom left),</li> + <li>enter (optional) program arguments in the <em>"Program Arguments"</em> field (bottom left), and</li> + <li>click on the <em>"Run Job"</em> button (bottom right).</li> + </ul> + If the <em>âShow optimizer planâ</em> option is enabled (default), the <em>plan view</em> is display next, otherwise the job is directly submitted to the JobManager for execution. + </div> + <div class="col-md-8"> + <a data-lightbox="compiler" href="{{ site.baseurl }}/page/img/webclient_job_view.png" data-lightbox="example-1"><img class="img-responsive" src="{{ site.baseurl }}/page/img/webclient_job_view.png" /></a> + </div> +</div> + +<br> The web interface can also handle multiple Flink jobs within a single jar file. To use this feature, package all required class files of all jobs into a single jar and specify the entry classes for each job as comma-separated-values in *program-class* argument within the jar's manifest file. The job view displays each entry class and you can pick any of them to preview the plan and/or submit the job to the JobManager. In case the jar's manifest file does not specify any entry class, you can specify it in the options field as: @@ -73,11 +84,19 @@ Furthermore, for each entry class implementing ```ProgramDescription``` interfac ### Plan View -The plan view shows the optimized execution plan of the submitted program in the upper half of the page. The bottom part of the page displays detailed information about the currently selected plan operator including: - -* the chosen shipping strategies (local forward, hash partition, range partition, broadcast, ...), -* the chosen local strategy (sort, hash join, merge join, ...), -* inferred data properties (partitioning, grouping, sorting), and -* used optimizer estimates (data size, I/O and network costs, ...). - -To submit the job for execution, click again on the *"Run Job"* button in the bottom right. +<div class="row"> + <div class="col-md-4"> + The plan view shows the optimized execution plan of the submitted program in the upper half of the page. The bottom part of the page displays detailed information about the currently selected plan operator including: + <ul> + <li>the chosen shipping strategies (local forward, hash partition, range partition, broadcast, ...),</li> + <li>the chosen local strategy (sort, hash join, merge join, ...),</li> + <li>inferred data properties (partitioning, grouping, sorting), and </li> + <li>used optimizer estimates (data size, I/O and network costs, ...).</li> + </ul> + + To submit the job for execution, click again on the <em>"Run Job"</em> button in the bottom right. + </div> + <div class="col-md-8"> + <a data-lightbox="compiler" href="{{ site.baseurl }}/page/img/webclient_plan_view.png" data-lightbox="example-1"><img class="img-responsive" src="{{ site.baseurl }}/page/img/webclient_plan_view.png" /></a> + </div> +</div>
