Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Update contrib guide: working on Flux issues #2104

Merged
merged 9 commits into from
May 29, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,23 @@ 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 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. 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.

Please talk to us on Slack, if you should get stuck anywhere. We appreciate
any help and look forward to talking to you soon!

## Certificate of Origin

Expand All @@ -24,7 +40,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

Expand Down
9 changes: 5 additions & 4 deletions site/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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":
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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).