Merge pull request #1771 from dimitropoulos/improveDocs

Improve Docs (focusing on local development)

CHANGELOG.md

@@ -3,8 +3,8 @@ operator is in [./CHANGELOG-helmop.md](./CHANGELOG-helmop.md).
 
 ## 1.10.1 (2019-02-13)
 
-This release provides a deeper integration with Azure (DevOps Git hosts 
-and ACR) and allows configuring how `fluxctl` finds `fluxd` (useful for 
+This release provides a deeper integration with Azure (DevOps Git hosts
+and ACR) and allows configuring how `fluxctl` finds `fluxd` (useful for
 clusters with multiple fluxd installations).
 
 ### Improvements
@@ -19,7 +19,7 @@ clusters with multiple fluxd installations).
 
 ### Thanks
 
-Lots of thanks to @alanjcastonguay, @hiddeco, and @sarath-p for their 
+Lots of thanks to @alanjcastonguay, @hiddeco, and @sarath-p for their
 contributions to this release.
 
 [#1694]: https://github.com/weaveworks/flux/pull/1694
@@ -324,7 +324,7 @@ because it introduces a new flag, `--listen-metrics`.
 ### Improvements
 
 - Prometheus metrics can be exposed on a port different from that of
-  the flux API, using the flag `--listen-metrics`
+  the Flux API, using the flag `--listen-metrics`
   [weaveworks/flux#1325](https://github.com/weaveworks/flux/pull/1325)
 
 ### Thanks
@@ -555,7 +555,7 @@ reindent blocks the first time it changes a file.
 
 ### Improvements
 
-- Let the flux daemon operate without a git repo, and report cluster resources as read-only when there is no corresponding manifest [weaveworks/flux#962](https://github.com/weaveworks/flux/pull/962)
+- Let the Flux daemon operate without a git repo, and report cluster resources as read-only when there is no corresponding manifest [weaveworks/flux#962](https://github.com/weaveworks/flux/pull/962)
 - Reinstate command-line arg for setting the git polling interval `--git-poll-interval` [weaveworks/flux#1030](https://github.com/weaveworks/flux/pull/1030)
 - Add `--git-ci-skip` (and for more fine control, `--git-ci-skip-message`) for customising flux's commit messages such that CI systems ignore the commits [weaveworks/flux#1011](https://github.com/weaveworks/flux/pull/1011)
 - Log the daemon version on startup [weaveworks/flux#1017](https://github.com/weaveworks/flux/pull/1017)
@@ -661,7 +661,7 @@ registry.
 
 - Flux daemon can be configured to populate the git commit author with
   the name of the requesting user
-- When multiple flux daemons share the same configuration repository,
+- When multiple Flux daemons share the same configuration repository,
   each fluxd only sends Slack notifications for commits that affect
   its branch/path
 - When a resource is locked the invoking user is recorded, along with
@@ -676,7 +676,7 @@ registry.
 
 ## 1.0.0 (2017-08-22)
 
-This release introduces significant changes to the way flux works:
+This release introduces significant changes to the way Flux works:
 
 - The git repository is now the system of record for your cluster
   state. Flux continually works to synchronise your cluster with the
@@ -723,7 +723,7 @@ More informative and helpful UI.
 
 -   Slack notifications are tidier
 -   Support for releasing to >1 service at a time
--   Better behaviour when flux deploys itself
+-   Better behaviour when Flux deploys itself
 -   More help given for commonly encountered errors
 -   Filter out Kubernetes add-ons from consideration
 -   More consistent Prometheus metric labeling

CONTRIBUTING.md

@@ -58,6 +58,8 @@ This is a rough outline of how to prepare a contribution:
 Refer to the [building doc](site/building.md) to find out how to build from
 source.
 
+Refer to the [up-and-running with Flux Development](site/get-started-developing.md) doc for a walkthrough on developing Flux locally.
+
 ### How to run the test suite
 
 You can run the unit tests by simply doing

chart/flux/CHANGELOG.md

@@ -39,9 +39,9 @@
 
 ## 0.6.0 (2019-01-14)
 
-**Note** To fix the connectivity problems between Flux and memcached we've changed the 
-memcached service from headless to ClusterIP. This change will make the Helm upgrade fail 
-with `ClusterIP field is immutable`. 
+**Note** To fix the connectivity problems between Flux and memcached we've changed the
+memcached service from headless to ClusterIP. This change will make the Helm upgrade fail
+with `ClusterIP field is immutable`.
 
 Before upgrading to 0.6.0 you have to delete the memcached headless service:
 
@@ -61,16 +61,16 @@ kubectl -n flux delete svc flux-memcached
    [weaveworks/flux#1626](https://github.com/weaveworks/flux/pull/1626)
     - Rectify error where `resources` are not `None` by default in `chart/flux/values.yaml`
     - Add more fields that are actually in `chart/flux/values.yaml`
-    - Separate `replicaCount` into a flux one and `helmOperator.replicaCount` one
+    - Separate `replicaCount` into a Flux one and `helmOperator.replicaCount` one
   - Only create the `flux-helm-tls-ca-config` file if `.Values.helmOperator.tls.caContent` exists.
-    Useful when doing flux upgrades but do not happen to know or want to specify
+    Useful when doing Flux upgrades but do not happen to know or want to specify
     the `caContent` in `values.yaml`. Otherwise, the existing caContent will be overriden with an
     empty value.
     [weaveworks/flux#1649](https://github.com/weaveworks/flux/pull/1649)
   - Add Flux AWS ECR flags
     [weaveworks/flux#1655](https://github.com/weaveworks/flux/pull/1655)
 
-   
+
 ## 0.5.2 (2018-12-20)
 
 ### Improvements
@@ -123,7 +123,7 @@ Thanks to @davidkarlsen, @stephenmoloney, @batpok, @squaremo,
 ### Improvements
 
  - Updated Helm operator to `v0.4.0`
-   [weaveworks/flux#1487](https://github.com/weaveworks/flux/pull/1487)    
+   [weaveworks/flux#1487](https://github.com/weaveworks/flux/pull/1487)
  - Added `--tiller-tls-hostname` Helm operator config flag to the chart
    [weaveworks/flux#1484](https://github.com/weaveworks/flux/pull/1484)
  - Include `valueFileSecrets` property in `helm-operator-crd.yaml`