From 1fab991671ef084a50282029b185ea557a57c419 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 28 May 2019 17:34:08 +0200 Subject: [PATCH 1/8] make markdownlint happy Signed-off-by: Daniel Holbach --- site/get-started.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/site/get-started.md b/site/get-started.md index 9fe48647d..a180c3a57 100644 --- a/site/get-started.md +++ b/site/get-started.md @@ -4,14 +4,14 @@ menu_order: 10 --- - [Get started with Flux](#get-started-with-flux) - * [Prerequisites](#prerequisites) - + [A Note on GKE with RBAC enabled](#a-note-on-gke-with-rbac-enabled) - * [Set up Flux](#set-up-flux) - * [Deploying Flux to the cluster](#deploying-flux-to-the-cluster) - * [Giving write access](#giving-write-access) - * [Committing a small change](#committing-a-small-change) - * [Confirm the change landed](#confirm-the-change-landed) - * [Conclusion](#conclusion) + - [Prerequisites](#prerequisites) + - [A Note on GKE with RBAC enabled](#a-note-on-gke-with-rbac-enabled) + - [Set up Flux](#set-up-flux) + - [Deploying Flux to the cluster](#deploying-flux-to-the-cluster) + - [Giving write access](#giving-write-access) + - [Committing a small change](#committing-a-small-change) + - [Confirm the change landed](#confirm-the-change-landed) + - [Conclusion](#conclusion) # Get started with Flux @@ -36,6 +36,7 @@ will work as well though. > ```sh > kubectl create clusterrolebinding "cluster-admin-$(whoami)" --clusterrole=cluster-admin --user="$(gcloud config get-value core/account)" > ``` +> > to avoid an error along the lines of > > `Error from server (Forbidden): error when creating "deploy/flux-account.yaml": @@ -63,9 +64,9 @@ $EDITOR deploy/flux-deployment.yaml In our example we are going to use [flux-get-started](https://github.com/weaveworks/flux-get-started). If you want to use that too, be sure to create a fork of it on GitHub and -add the git URL to the config file above. After that, set the `--git-path` -flag to `--git-path=namespaces,workloads`, this is meant to exclude Helm -manifests. Again, if you want to get started with Helm, please refer to the +add the git URL to the config file above. After that, set the `--git-path` +flag to `--git-path=namespaces,workloads`, this is meant to exclude Helm +manifests. Again, if you want to get started with Helm, please refer to the [Helm section](./helm-get-started.md). ## Deploying Flux to the cluster @@ -150,5 +151,5 @@ very straight-forward and are a quite natural work-flow. As a next step, you might want to dive deeper into [how to control Flux](./fluxctl.md), check out [more sophisticated setups](./standalone-setup.md) or go through our hands-on -tutorial about driving Flux, e.g. +tutorial about driving Flux, e.g. [automations, annotations and locks](annotations-tutorial.md). \ No newline at end of file From 506493886d5a1a595b469d4d34bf6473d5f99092 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 28 May 2019 17:35:52 +0200 Subject: [PATCH 2/8] mention flux meeting invitation Signed-off-by: Daniel Holbach --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a3040961..8c5c04da9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,8 @@ The project uses Slack: To join the conversation, simply join the The Flux developers use a mailing list to discuss development as well. Simply subscribe to [flux-dev on Google Groups](https://groups.google.com/forum/#!forum/flux-dev) to join the -conversation. +conversation (this will also add an invitation to your Google calendar +for our [Flux meeting](https://github.com/weaveworks/flux/wiki/Meeting)). ## Getting Started From 4722df8e848a874bf7deffd0edf00d9820fdd1c1 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 28 May 2019 17:42:13 +0200 Subject: [PATCH 3/8] add section about working on Flux issues Signed-off-by: Daniel Holbach --- CONTRIBUTING.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c5c04da9..44caded5e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,24 @@ pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted. -We gratefully welcome improvements to documentation as well as to code. +We gratefully welcome improvements to issues and documentation as well as to code. + +## Working on issues + +If you like Flux and want to get involved in the team, a great way to get started +is reviewing our [blocked-needs-validation](https://github.com/weaveworks/flux/issues?q=is%3Aissue+is%3Aopen+label%3Ablocked-needs-validation) issues. + +The idea here is that new issues are first confirmed by somebody in the team, +which might require asking for more information, testing with a fresh Flux +environment and once confirmed (and more information added to the issue), removing +the `blocked-needs-validation` label. Afterwards the issue can be worked on and +fixed by the team. + +To set up Flux to test things, there's the [standalone install](site/get-started.md) +and the [Helm install](site/helm-get-started.md), which might be helpful. + +Please talk to us on Slack, if you should get stuck anywhere. We appreciate +any help and look forward welcoming you to the team! ## Certificate of Origin From 78a8c25d834094039dd1fcb9df7008bae9336afb Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 28 May 2019 18:23:44 +0200 Subject: [PATCH 4/8] 'join the team' could mean a lot of things - change wording somewhat Signed-off-by: Daniel Holbach --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 44caded5e..d2325143f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ We gratefully welcome improvements to issues and documentation as well as to cod ## Working on issues -If you like Flux and want to get involved in the team, a great way to get started +If you like Flux and want to get involved in the project, a great way to get started is reviewing our [blocked-needs-validation](https://github.com/weaveworks/flux/issues?q=is%3Aissue+is%3Aopen+label%3Ablocked-needs-validation) issues. The idea here is that new issues are first confirmed by somebody in the team, @@ -22,7 +22,7 @@ To set up Flux to test things, there's the [standalone install](site/get-started and the [Helm install](site/helm-get-started.md), which might be helpful. Please talk to us on Slack, if you should get stuck anywhere. We appreciate -any help and look forward welcoming you to the team! +any help and look forward talking to you soon! ## Certificate of Origin From 69f3095b51b8bdf057da506b5637ad4e4bedd2e6 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 28 May 2019 18:30:22 +0200 Subject: [PATCH 5/8] language finickiness improvemnt from Michael :-) Co-Authored-By: Michael Bridgen --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d2325143f..d7bf6bf84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ To set up Flux to test things, there's the [standalone install](site/get-started and the [Helm install](site/helm-get-started.md), which might be helpful. Please talk to us on Slack, if you should get stuck anywhere. We appreciate -any help and look forward talking to you soon! +any help and look forward to talking to you soon! ## Certificate of Origin From 7c9eb22ead07952f9e1fe10bcbe220382091ef8e Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 28 May 2019 18:31:10 +0200 Subject: [PATCH 6/8] simplify process description Co-Authored-By: Michael Bridgen --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d7bf6bf84..629575749 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ We gratefully welcome improvements to issues and documentation as well as to cod If you like Flux and want to get involved in the project, a great way to get started is reviewing our [blocked-needs-validation](https://github.com/weaveworks/flux/issues?q=is%3Aissue+is%3Aopen+label%3Ablocked-needs-validation) issues. -The idea here is that new issues are first confirmed by somebody in the team, +The idea here is that new issues are confirmed, which might require asking for more information, testing with a fresh Flux environment and once confirmed (and more information added to the issue), removing the `blocked-needs-validation` label. Afterwards the issue can be worked on and From ebfa058c43a8a7b5fa754b08af6e39b4d7997a91 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Tue, 28 May 2019 18:35:20 +0200 Subject: [PATCH 7/8] simplify process description Signed-off-by: Daniel Holbach --- CONTRIBUTING.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 629575749..35ba9d7fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,11 +12,10 @@ We gratefully welcome improvements to issues and documentation as well as to cod If you like Flux and want to get involved in the project, a great way to get started is reviewing our [blocked-needs-validation](https://github.com/weaveworks/flux/issues?q=is%3Aissue+is%3Aopen+label%3Ablocked-needs-validation) issues. -The idea here is that new issues are confirmed, -which might require asking for more information, testing with a fresh Flux -environment and once confirmed (and more information added to the issue), removing -the `blocked-needs-validation` label. Afterwards the issue can be worked on and -fixed by the team. +The idea here is that new issues are confirmed, which might require asking +for more information, testing with a fresh Flux environment. Once confirmed, +the `blocked-needs-validation` label is removed, and the issue can be worked +on. To set up Flux to test things, there's the [standalone install](site/get-started.md) and the [Helm install](site/helm-get-started.md), which might be helpful. From 48ee1434117098ea47d1fd48875932eda799a806 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Wed, 29 May 2019 07:30:38 +0200 Subject: [PATCH 8/8] revert sublist change Signed-off-by: Daniel Holbach --- site/get-started.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/site/get-started.md b/site/get-started.md index a180c3a57..e98a5ff09 100644 --- a/site/get-started.md +++ b/site/get-started.md @@ -4,14 +4,14 @@ menu_order: 10 --- - [Get started with Flux](#get-started-with-flux) - - [Prerequisites](#prerequisites) - - [A Note on GKE with RBAC enabled](#a-note-on-gke-with-rbac-enabled) - - [Set up Flux](#set-up-flux) - - [Deploying Flux to the cluster](#deploying-flux-to-the-cluster) - - [Giving write access](#giving-write-access) - - [Committing a small change](#committing-a-small-change) - - [Confirm the change landed](#confirm-the-change-landed) - - [Conclusion](#conclusion) + * [Prerequisites](#prerequisites) + + [A Note on GKE with RBAC enabled](#a-note-on-gke-with-rbac-enabled) + * [Set up Flux](#set-up-flux) + * [Deploying Flux to the cluster](#deploying-flux-to-the-cluster) + * [Giving write access](#giving-write-access) + * [Committing a small change](#committing-a-small-change) + * [Confirm the change landed](#confirm-the-change-landed) + * [Conclusion](#conclusion) # Get started with Flux