[jira] [Commented] (FLINK-6330) Improve Docker documentation

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/FLINK-6330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16005193#comment-16005193
 ] 

ASF GitHub Bot commented on FLINK-6330:
---

Github user asfgit closed the pull request at:

https://github.com/apache/flink/pull/3751


> Improve Docker documentation
> 
>
> Key: FLINK-6330
> URL: https://issues.apache.org/jira/browse/FLINK-6330
> Project: Flink
>  Issue Type: Bug
>  Components: Docker
>Affects Versions: 1.2.0
>Reporter: Patrick Lucas
>Assignee: Patrick Lucas
> Fix For: 1.2.2
>
>
> The "Docker" page in the docs exists but is blank.
> Add something useful here, including references to the official images that 
> should exist once 1.2.1 is released, and add a brief "Kubernetes" page as 
> well, referencing the [helm chart|https://github.com/docker-flink/examples]. 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (FLINK-6330) Improve Docker documentation

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/FLINK-6330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16005071#comment-16005071
 ] 

ASF GitHub Bot commented on FLINK-6330:
---

Github user greghogan commented on a diff in the pull request:

https://github.com/apache/flink/pull/3751#discussion_r115801773
  
--- Diff: docs/page/css/syntax.css ---
@@ -77,3 +77,6 @@
 .highlight .vg { color: #008080 } /* Name.Variable.Global */
 .highlight .vi { color: #008080 } /* Name.Variable.Instance */
 .highlight .il { color: #00 } /* Literal.Number.Integer.Long */
+
+/* Missing YAML styles */
+.highlight .l-Scalar-Plain { color: #008080 }
--- End diff --

I think we should merge this PR without this change and look at fixing this 
in another ticket. There are [other](https://highlightjs.org) highlighters with 
true YAML support.


> Improve Docker documentation
> 
>
> Key: FLINK-6330
> URL: https://issues.apache.org/jira/browse/FLINK-6330
> Project: Flink
>  Issue Type: Bug
>  Components: Docker
>Affects Versions: 1.2.0
>Reporter: Patrick Lucas
>Assignee: Patrick Lucas
> Fix For: 1.2.2
>
>
> The "Docker" page in the docs exists but is blank.
> Add something useful here, including references to the official images that 
> should exist once 1.2.1 is released, and add a brief "Kubernetes" page as 
> well, referencing the [helm chart|https://github.com/docker-flink/examples]. 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (FLINK-6330) Improve Docker documentation

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/FLINK-6330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16004756#comment-16004756
 ] 

ASF GitHub Bot commented on FLINK-6330:
---

Github user patricklucas commented on a diff in the pull request:

https://github.com/apache/flink/pull/3751#discussion_r115753699
  
--- Diff: docs/page/css/syntax.css ---
@@ -77,3 +77,6 @@
 .highlight .vg { color: #008080 } /* Name.Variable.Global */
 .highlight .vi { color: #008080 } /* Name.Variable.Instance */
 .highlight .il { color: #00 } /* Literal.Number.Integer.Long */
+
+/* Missing YAML styles */
+.highlight .l-Scalar-Plain { color: #008080 }
--- End diff --

Yeah, the highlighter we use doesn't have any built-in styling for YAML. I 
had to search around quite a bit for context and came up mostly dry.

Moreover, the actual tokenizer it uses only emits two token types, 
l-Scalar-Plain and p-Indicator. (You can see this in action by inspecting the 
HTML 
[here](https://ci.apache.org/projects/flink/flink-docs-release-1.2/monitoring/metrics.html#jmx-orgapacheflinkmetricsjmxjmxreporter))

This change applies the color I found most applicable from the existing 
highlighting rules and applies it to l-Scalar-Plain to make it at least 
slightly more interesting than black-on-white.


> Improve Docker documentation
> 
>
> Key: FLINK-6330
> URL: https://issues.apache.org/jira/browse/FLINK-6330
> Project: Flink
>  Issue Type: Bug
>  Components: Docker
>Affects Versions: 1.2.0
>Reporter: Patrick Lucas
>Assignee: Patrick Lucas
> Fix For: 1.2.2
>
>
> The "Docker" page in the docs exists but is blank.
> Add something useful here, including references to the official images that 
> should exist once 1.2.1 is released, and add a brief "Kubernetes" page as 
> well, referencing the [helm chart|https://github.com/docker-flink/examples]. 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (FLINK-6330) Improve Docker documentation

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/FLINK-6330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16004736#comment-16004736
 ] 

ASF GitHub Bot commented on FLINK-6330:
---

Github user greghogan commented on a diff in the pull request:

https://github.com/apache/flink/pull/3751#discussion_r115750993
  
--- Diff: docs/page/css/syntax.css ---
@@ -77,3 +77,6 @@
 .highlight .vg { color: #008080 } /* Name.Variable.Global */
 .highlight .vi { color: #008080 } /* Name.Variable.Instance */
 .highlight .il { color: #00 } /* Literal.Number.Integer.Long */
+
+/* Missing YAML styles */
+.highlight .l-Scalar-Plain { color: #008080 }
--- End diff --

What is this line doing? Why does `YAML` equate to `l-Scalar-Plain`? Is 
`YAML` unknown to the highlighter?


> Improve Docker documentation
> 
>
> Key: FLINK-6330
> URL: https://issues.apache.org/jira/browse/FLINK-6330
> Project: Flink
>  Issue Type: Bug
>  Components: Docker
>Affects Versions: 1.2.0
>Reporter: Patrick Lucas
>Assignee: Patrick Lucas
> Fix For: 1.2.2
>
>
> The "Docker" page in the docs exists but is blank.
> Add something useful here, including references to the official images that 
> should exist once 1.2.1 is released, and add a brief "Kubernetes" page as 
> well, referencing the [helm chart|https://github.com/docker-flink/examples]. 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (FLINK-6330) Improve Docker documentation

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/FLINK-6330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16004264#comment-16004264
 ] 

ASF GitHub Bot commented on FLINK-6330:
---

Github user patricklucas commented on the issue:

https://github.com/apache/flink/pull/3751
  
The link is available now!


> Improve Docker documentation
> 
>
> Key: FLINK-6330
> URL: https://issues.apache.org/jira/browse/FLINK-6330
> Project: Flink
>  Issue Type: Bug
>  Components: Docker
>Affects Versions: 1.2.0
>Reporter: Patrick Lucas
>Assignee: Patrick Lucas
> Fix For: 1.2.2
>
>
> The "Docker" page in the docs exists but is blank.
> Add something useful here, including references to the official images that 
> should exist once 1.2.1 is released, and add a brief "Kubernetes" page as 
> well, referencing the [helm chart|https://github.com/docker-flink/examples]. 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (FLINK-6330) Improve Docker documentation

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/FLINK-6330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16002944#comment-16002944
 ] 

ASF GitHub Bot commented on FLINK-6330:
---

Github user patricklucas commented on the issue:

https://github.com/apache/flink/pull/3751
  
@greghogan we're waiting patiently for @tianon to complete his review of 
docker-library/official-images#2895. :)

As far as I know, we've done everything we need to do to get the images 
published. We have a +1 from @yosifkit, but two reviews are required.


> Improve Docker documentation
> 
>
> Key: FLINK-6330
> URL: https://issues.apache.org/jira/browse/FLINK-6330
> Project: Flink
>  Issue Type: Bug
>  Components: Docker
>Affects Versions: 1.2.0
>Reporter: Patrick Lucas
>Assignee: Patrick Lucas
> Fix For: 1.2.2
>
>
> The "Docker" page in the docs exists but is blank.
> Add something useful here, including references to the official images that 
> should exist once 1.2.1 is released, and add a brief "Kubernetes" page as 
> well, referencing the [helm chart|https://github.com/docker-flink/examples]. 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (FLINK-6330) Improve Docker documentation

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/FLINK-6330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16002940#comment-16002940
 ] 

ASF GitHub Bot commented on FLINK-6330:
---

Github user greghogan commented on the issue:

https://github.com/apache/flink/pull/3751
  
@patricklucas when will the link be available? It would be great to have 
this merged for 1.3.


> Improve Docker documentation
> 
>
> Key: FLINK-6330
> URL: https://issues.apache.org/jira/browse/FLINK-6330
> Project: Flink
>  Issue Type: Bug
>  Components: Docker
>Affects Versions: 1.2.0
>Reporter: Patrick Lucas
>Assignee: Patrick Lucas
> Fix For: 1.2.2
>
>
> The "Docker" page in the docs exists but is blank.
> Add something useful here, including references to the official images that 
> should exist once 1.2.1 is released, and add a brief "Kubernetes" page as 
> well, referencing the [helm chart|https://github.com/docker-flink/examples]. 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (FLINK-6330) Improve Docker documentation

[David Anderson (JIRA)]

[ 
https://issues.apache.org/jira/browse/FLINK-6330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15996615#comment-15996615
 ] 

David Anderson commented on FLINK-6330:
---

This appears to subsume 
[FLINK-5460|https://issues.apache.org/jira/browse/FLINK-5460].

> Improve Docker documentation
> 
>
> Key: FLINK-6330
> URL: https://issues.apache.org/jira/browse/FLINK-6330
> Project: Flink
>  Issue Type: Bug
>  Components: Docker
>Affects Versions: 1.2.0
>Reporter: Patrick Lucas
>Assignee: Patrick Lucas
> Fix For: 1.2.2
>
>
> The "Docker" page in the docs exists but is blank.
> Add something useful here, including references to the official images that 
> should exist once 1.2.1 is released, and add a brief "Kubernetes" page as 
> well, referencing the [helm chart|https://github.com/docker-flink/examples]. 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (FLINK-6330) Improve Docker documentation

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/FLINK-6330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15983411#comment-15983411
 ] 

ASF GitHub Bot commented on FLINK-6330:
---

Github user patricklucas commented on the issue:

https://github.com/apache/flink/pull/3751
  
It will be available before the next release, though I noticed just 
yesterday that it seems we build the [official 1.2 
docs](https://ci.apache.org/projects/flink/flink-docs-release-1.2/) 
(erroneously?) from a development branch instead of the actual tagged release.

I'm about ready to submit the PR to get the official images created, but 
it's fine if you want to wait.


> Improve Docker documentation
> 
>
> Key: FLINK-6330
> URL: https://issues.apache.org/jira/browse/FLINK-6330
> Project: Flink
>  Issue Type: Bug
>  Components: Docker
>Affects Versions: 1.2.0
>Reporter: Patrick Lucas
>Assignee: Patrick Lucas
> Fix For: 1.2.2
>
>
> The "Docker" page in the docs exists but is blank.
> Add something useful here, including references to the official images that 
> should exist once 1.2.1 is released, and add a brief "Kubernetes" page as 
> well, referencing the [helm chart|https://github.com/docker-flink/examples]. 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (FLINK-6330) Improve Docker documentation

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/FLINK-6330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15983383#comment-15983383
 ] 

ASF GitHub Bot commented on FLINK-6330:
---

Github user StephanEwen commented on the issue:

https://github.com/apache/flink/pull/3751
  
Sorry, taking a step back.

It seems that https://hub.docker.com/_/flink/ is not yet available. Should 
we postpone this merge until it is available?


> Improve Docker documentation
> 
>
> Key: FLINK-6330
> URL: https://issues.apache.org/jira/browse/FLINK-6330
> Project: Flink
>  Issue Type: Bug
>  Components: Docker
>Affects Versions: 1.2.0
>Reporter: Patrick Lucas
>Assignee: Patrick Lucas
> Fix For: 1.2.2
>
>
> The "Docker" page in the docs exists but is blank.
> Add something useful here, including references to the official images that 
> should exist once 1.2.1 is released, and add a brief "Kubernetes" page as 
> well, referencing the [helm chart|https://github.com/docker-flink/examples]. 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (FLINK-6330) Improve Docker documentation

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/FLINK-6330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15983371#comment-15983371
 ] 

ASF GitHub Bot commented on FLINK-6330:
---

Github user StephanEwen commented on the issue:

https://github.com/apache/flink/pull/3751
  
Great, thanks!

Merging this...


> Improve Docker documentation
> 
>
> Key: FLINK-6330
> URL: https://issues.apache.org/jira/browse/FLINK-6330
> Project: Flink
>  Issue Type: Bug
>  Components: Docker
>Affects Versions: 1.2.0
>Reporter: Patrick Lucas
>Assignee: Patrick Lucas
> Fix For: 1.2.2
>
>
> The "Docker" page in the docs exists but is blank.
> Add something useful here, including references to the official images that 
> should exist once 1.2.1 is released, and add a brief "Kubernetes" page as 
> well, referencing the [helm chart|https://github.com/docker-flink/examples]. 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

[jira] [Commented] (FLINK-6330) Improve Docker documentation

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/FLINK-6330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15978906#comment-15978906
 ] 

ASF GitHub Bot commented on FLINK-6330:
---

GitHub user patricklucas opened a pull request:

https://github.com/apache/flink/pull/3751

[FLINK-6330] [docs] Add basic Docker, K8s docs

I may do some more work on these before 1.2.2/1.3, but I'd like to at least 
get this basic information into master.

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/patricklucas/flink 
FLINK-6330_improve_docker_docs

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/flink/pull/3751.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #3751


commit 6894b3711fa1ab145f1ef871bcdcd74e7c7e9a6b
Author: Patrick Lucas 
Date:   2017-04-21T13:00:53Z

[FLINK-6330] [docs] Add basic Docker, K8s docs




> Improve Docker documentation
> 
>
> Key: FLINK-6330
> URL: https://issues.apache.org/jira/browse/FLINK-6330
> Project: Flink
>  Issue Type: Bug
>  Components: Docker
>Affects Versions: 1.2.0
>Reporter: Patrick Lucas
>Assignee: Patrick Lucas
> Fix For: 1.2.2
>
>
> The "Docker" page in the docs exists but is blank.
> Add something useful here, including references to the official images that 
> should exist once 1.2.1 is released, and add a brief "Kubernetes" page as 
> well, referencing the [helm chart|https://github.com/docker-flink/examples]. 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)