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

Update contrib guide: working on Flux issues #2104

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1fab991
make markdownlint happy
May 28, 2019
5064938
mention flux meeting invitation
May 28, 2019
4722df8
add section about working on Flux issues
May 28, 2019
78a8c25
'join the team' could mean a lot of things - change wording somewhat
May 28, 2019
69f3095
language finickiness improvemnt from Michael :-)
May 28, 2019
7c9eb22
simplify process description
May 28, 2019
ebfa058
simplify process description
May 28, 2019
48ee143
revert sublist change
May 29, 2019
ebb0185
Merge branch 'master' into update-contrib-guide
May 29, 2019
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
22 changes: 20 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some people may take "team" to imply something more formal than what's meant here. To avoid introducing this ambiguity, you could omit the mention here and in the next para. (It would be good to retain the welcoming message at the end, if it can be done)

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,
dholbach marked this conversation as resolved.
Show resolved Hide resolved
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.. a fresh Flux environment. Once confirmed, the blocked-needs-validation label is removed, and the issue can be worked on ...

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

Expand All @@ -24,7 +41,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
25 changes: 13 additions & 12 deletions site/get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this invalid?

https://www.markdownguide.org/basic-syntax/#unordered-lists
https://docs.gitlab.com/ee/user/markdown.html#lists
https://daringfireball.net/projects/markdown/syntax#list

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it was https://github.com/DavidAnson/markdownlint/blob/v0.11.0/doc/Rules.md#md004---unordered-list-style that showed up for me. I can roll back the change too.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that is because the default configuration is not set to 'sublist' style.

For example, the following is valid for the sublist style because the outer-most indent uses asterisk, the middle indent uses plus, and the inner-most indent uses dash:

* Item 1
  + Item 2
    - Item 3
  + Item 4
* Item 4
  + Item 5

I have no strong opinion on this but I think it improves readability for raw markdown files (which I read more often than parsed files).

- [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

Expand All @@ -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).