You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by gy...@apache.org on 2022/03/28 08:35:49 UTC

[flink-kubernetes-operator] branch main updated: [FLINK-26862] Link the Github repository from Operator documentation

This is an automated email from the ASF dual-hosted git repository.

gyfora pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-kubernetes-operator.git


The following commit(s) were added to refs/heads/main by this push:
     new 33eb09b  [FLINK-26862] Link the Github repository from Operator documentation
33eb09b is described below

commit 33eb09b749cc57b4badfcfb4533820b4e5454c23
Author: Matyas Orhidi <ma...@apple.com>
AuthorDate: Fri Mar 25 14:43:17 2022 +0100

    [FLINK-26862] Link the Github repository from Operator documentation
---
 docs/content/_index.md                                         |  2 +-
 docs/content/docs/try-flink-kubernetes-operator/quick-start.md | 10 ++++++++--
 2 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/docs/content/_index.md b/docs/content/_index.md
index c49e195..fcde5ab 100644
--- a/docs/content/_index.md
+++ b/docs/content/_index.md
@@ -24,7 +24,7 @@ under the License.
 
 # Flink Kubernetes Operator
 
-The Flink Kubernetes Operator extends the [Kubernetes](https://kubernetes.io/) API with the ability to manage and operate 
+The [Flink Kubernetes Operator](https://github.com/apache/flink-kubernetes-operator) extends the [Kubernetes](https://kubernetes.io/) API with the ability to manage and operate
 Flink Deployments. The operator features the following amongst others:
 - Deploy and monitor Flink Application and Session deployments
 - Upgrade, suspend and delete deployments
diff --git a/docs/content/docs/try-flink-kubernetes-operator/quick-start.md b/docs/content/docs/try-flink-kubernetes-operator/quick-start.md
index 860816f..3050d53 100644
--- a/docs/content/docs/try-flink-kubernetes-operator/quick-start.md
+++ b/docs/content/docs/try-flink-kubernetes-operator/quick-start.md
@@ -36,8 +36,9 @@ We assume that you have a local installations of the following:
 1. [docker](https://docs.docker.com/)
 2. [kubernetes](https://kubernetes.io/)
 3. [helm](https://helm.sh/docs/intro/quickstart/)
+4. [git](https://github.com/git-guides/install-git/)
 
-So that the `docker`, `kubectl` and `helm` commands are available on your local system.
+So that the `docker`, `kubectl`, `helm` and `git` commands are available on your local system.
 
 For docker we recommend that you have [Docker Desktop](https://www.docker.com/products/docker-desktop) installed 
 and configured with at least 8GB of RAM.
@@ -62,7 +63,12 @@ minikube start --kubernetes-version=v1.21.5
 
 We also recommend [k9s](https://k9scli.io/) as GUI for kubernetes, but it is optional for this quickstart guide.
 
-## Building the operator image
+## Building the operator image from source
+
+```shell
+git clone https://github.com/apache/flink-kubernetes-operator.git
+cd flink-kubernetes-operator
+```
 
 You can build the docker image of the operator via the following command from the project root folder:
 ```bash