[FLINK-29961][doc] Make referencing custom image clearer for Docker #20935
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
liuml07
force-pushed
the
minor-standalon-docker.md
branch
from
ea41aa4
to
03bf998
Compare
liuml07
force-pushed
the
minor-standalon-docker.md
branch
from
03bf998
to
8ef9ecc
Compare
liuml07
force-pushed
the
minor-standalon-docker.md
branch
from
8ef9ecc
to
83e8e91
Compare
MartijnVisser
requested changes
Oct 27, 2022
There was a problem hiding this comment.
@liuml07 Thanks for this, I do think we can improve it a bit more. Please have a look
docs/content.zh/docs/deployment/resource-providers/standalone/docker.md
Outdated
Show resolved
Hide resolved
|
|
||
| ```Dockerfile | ||
| FROM flink:{{< stable >}}{{< version >}}-scala{{< scala_version >}}{{< /stable >}}{{< unstable >}}latest{{< /unstable >}} | ||
| RUN wget -P /opt/flink/lib https://repo.maven.apache.org/maven2/org/apache/flink/flink-sql-connector-kafka_2.12/{{< version >}}/flink-sql-connector-kafka_scala{{< scala_version >}}-{{< version >}}.jar | ||
| ``` | ||
|
|
||
| and reference it (e.g via the `build`) command in the Dockerfile. | ||
| and reference it (e.g via the `build`) command in the Dockerfile. | ||
| and reference this Dockerfile with the `build` command in the `docker-compose.yml` file. |
There was a problem hiding this comment.
Perhaps it better to actually display the build command that someone needs to type?
There was a problem hiding this comment.
Updated the doc. After building the doc screenshot is like:
liuml07
force-pushed
the
minor-standalon-docker.md
branch
2 times, most recently
from
0f153d2
to
1212fef
Compare
liuml07
changed the title
|
This was a hotfix PR but since the latest change introduces some example code, I created a JIRA for it. |
…docker.md Co-authored-by: MartijnVisser <martijn@2symbols.com>
liuml07
force-pushed
the
minor-standalon-docker.md
branch
from
1212fef
to
8ed09d4
Compare
MartijnVisser
requested changes
Nov 14, 2022
There was a problem hiding this comment.
@roncohen Please also take my suggestion changes into account
docs/content.zh/docs/deployment/resource-providers/standalone/docker.md
Outdated
Show resolved
Hide resolved
docs/content.zh/docs/deployment/resource-providers/standalone/docker.md
Outdated
Show resolved
Hide resolved
|
You probably didn’t mean to mention me? ;) @MartijnVisser |
I honestly don't know how that happened but indeed, I didn't mean to tag you, apologies 😅 |
|
@liuml07 Can you take my suggested changes into account? |
…docker.md Co-authored-by: MartijnVisser <martijn@2symbols.com>
…docker.md Co-authored-by: MartijnVisser <martijn@2symbols.com>
liuml07
force-pushed
the
minor-standalon-docker.md
branch
from
b996109
to
5891263
Compare
liuml07
force-pushed
the
minor-standalon-docker.md
branch
from
5891263
to
aef1c58
Compare
liuml07
commented
Nov 14, 2022
|
|
||
| ```Dockerfile | ||
| FROM flink:{{< stable >}}{{< version >}}-scala{{< scala_version >}}{{< /stable >}}{{< unstable >}}latest{{< /unstable >}} | ||
| RUN wget -P /opt/flink/lib https://repo.maven.apache.org/maven2/org/apache/flink/flink-sql-connector-kafka_2.12/{{< version >}}/flink-sql-connector-kafka_scala{{< scala_version >}}-{{< version >}}.jar | ||
| RUN wget -P /opt/flink/lib https://repo.maven.apache.org/maven2/org/apache/flink/flink-sql-connector-kafka/{{< version >}}/flink-sql-connector-kafka_scala-{{< version >}}.jar |
There was a problem hiding this comment.
I found the Kafka connector is not including Scala version in the name. So I updated this as well.
|
Hi @MartijnVisser could you take another look? Thanks |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
Make referencing custom image clearer for Docker
Brief change log
Rephrase the words how to reference custom image when building with Docker standalone mode.
Also add example code.
Verifying this change
Please make sure both new and modified tests in this PR follows the conventions defined in our code quality guide: https://flink.apache.org/contributing/code-style-and-quality-common.html#testing
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): (yes / no)Documentation