Fix broken doc links (#2306)

Fix broken doc links

CONTRIBUTING.md

@@ -18,8 +18,8 @@ the `blocked-needs-validation` label is removed, and the issue can be worked
 on.
 
 To set up Flux to test things, there's documentation about setting up a
-[standalone install](docs/get-started.md) and a [Helm
-install](docs/helm-get-started.md), which might be helpful.
+[standalone install](docs/install/get-started.md) and a [Helm
+install](docs/install/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!
@@ -73,10 +73,10 @@ This is a rough outline of how to prepare a contribution:
 
 ### How to build and run the project
 
-Refer to the [building doc](docs/building.md) to find out how to build from
+Refer to the [building doc](docs/development/building.md) to find out how to build from
 source.
 
-Refer to the [Get Started Developing](docs/get-started-developing.md) guide for a walkthrough on developing Flux locally.
+Refer to the [Get Started Developing](docs/development/get-started-developing.md) guide for a walkthrough on developing Flux locally.
 
 ### How to run the test suite
 

README.md

@@ -48,7 +48,7 @@ Its major features are:
 
 - [Automated git → cluster synchronisation](/docs/introduction.md#automated-git-cluster-synchronisation)
 - [Automated deployment of new container images](/docs/introduction.md#automated-deployment-of-new-container-images)
-- [Integrations with other devops tools](/docs/introduction.md#integrations-with-other-devops-tools) ([Helm](/docs/helm-integration.md) and more)
+- [Integrations with other devops tools](/docs/introduction.md#integrations-with-other-devops-tools) ([Helm](/docs/helm/helm-integration.md) and more)
 - No additional service or infrastructure needed - Flux lives inside your
   cluster
 - Straight-forward control over the state of deployments in the
@@ -102,18 +102,18 @@ Get started by browsing through the documentation below:
   - [Introduction to Flux](/docs/introduction.md)
   - [FAQ](/docs/faq.md) and [frequently encountered issues](https://github.com/fluxcd/flux/labels/FAQ)
   - [How it works](/docs/how-it-works.md)
-  - [Considerations regarding installing Flux](/docs/installing.md)
-  - [Flux <-> Helm integration](/docs/helm-integration.md)
+  - [Considerations regarding installing Flux](/docs/install/index.md)
+  - [Flux <-> Helm integration](/docs/helm/helm-integration.md)
 - Get Started with Flux
-  - [Standalone Flux](/docs/get-started.md)
-  - [Flux using Helm](/docs/helm-get-started.md)
-  - [Automation: annotations and locks](/docs/annotations-tutorial.md)
+  - [Standalone Flux](/docs/install/get-started.md)
+  - [Flux using Helm](/docs/install/helm-get-started.md)
+  - [Automation: annotations and locks](/docs/using/annotations-tutorial.md)
 - Operating Flux
-  - [Using fluxctl to control Flux](/docs/fluxctl.md)
-  - [Helm Operator](/docs/helm-operator.md)
+  - [Using fluxctl to control Flux](/docs/using/fluxctl.md)
+  - [Helm Operator](/docs/helm/helm-operator.md)
   - [Troubleshooting](/docs/troubleshooting.md)
   - [Frequently encountered issues](https://github.com/fluxcd/flux/labels/FAQ)
-  - [Upgrading to Flux v1](/docs/upgrading-to-1.0.md)
+  - [Upgrading to Flux v1](/docs/using/upgrading-to-1.0.md)
 
 ### Integrations
 
@@ -135,14 +135,14 @@ The Flux project adheres to the [CNCF Code of
 Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
 
 Instances of abusive, harassing, or otherwise unacceptable behavior
-may be reported by contacting a *Flux* project maintainer, or the CNCF
+may be reported by contacting a _Flux_ project maintainer, or the CNCF
 mediator, Mishi Choudhary <mishi@linux.com>.
 
 To familiarise yourself with the project and how things work, you might
 be interested in the following:
 
 - [Our contributions guidelines](CONTRIBUTING.md)
-- [Build documentation](/docs/building.md)
+- [Build documentation](/docs/development/building.md)
 - [Release documentation](/internal_docs/releasing.md)
 
 ## <a name="help"></a>Getting Help

chart/flux/README.md

@@ -22,7 +22,7 @@ This means fluxd can fail to apply changes to HelmRelease resources.
 ### Helm
 
 Tiller should be running in the cluster, though
-[helm-operator](../../docs/helm-operator.md) will wait
+[helm-operator](../../docs/helm/helm-operator.md) will wait
 until it can find one.
 
 # Git repo
@@ -37,7 +37,7 @@ until it can find one.
 ## Installation
 
 We put together a simple [Get Started
-guide](../../docs/helm-get-started.md) which takes about 5-10 minutes to follow.
+guide](../../docs/install/helm-get-started.md) which takes about 5-10 minutes to follow.
 You will have a fully working Flux installation deploying workloads to your cluster.
 
 ## Installing Flux using Helm
@@ -154,7 +154,7 @@ The [configuration](#configuration) section lists all the parameters that can be
 #### Setup Git deploy
 
 At startup Flux generates a SSH key and logs the public key.
-Find the SSH public key by installing [fluxctl](../../docs/fluxctl.md) and
+Find the SSH public key by installing [fluxctl](../../docs/using/fluxctl.md) and
 running:
 
 ```sh
@@ -288,8 +288,8 @@ The following tables lists the configurable parameters of the Flux chart and the
 | `helmOperator.affinity`                           | `{}`                                                 | Affinity properties for the helmOperator deployment
 | `kube.config`                                     | [See values.yaml](/chart/flux/values.yaml#L151-L165) | Override for kubectl default config in the Flux pod(s).
 | `prometheus.enabled`                              | `false`                                              | If enabled, adds prometheus annotations to Flux and helmOperator pod(s)
-| `syncGarbageCollection.enabled`                   | `false`                                              | If enabled, fluxd will delete resources that it created, but are no longer present in git (experimental, see [garbage collection](/docs/garbagecollection.md))
-| `syncGarbageCollection.dry`                       | `false`                                              | If enabled, fluxd won't delete any resources, but log the garbage collection output (experimental, see [garbage collection](/docs/garbagecollection.md))
+| `syncGarbageCollection.enabled`                   | `false`                                              | If enabled, fluxd will delete resources that it created, but are no longer present in git (experimental, see [garbage collection](/docs/features/garbagecollection.md))
+| `syncGarbageCollection.dry`                       | `false`                                              | If enabled, fluxd won't delete any resources, but log the garbage collection output (experimental, see [garbage collection](/docs/features/garbagecollection.md))
 
 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example:
 

chart/flux/templates/NOTES.txt

@@ -3,7 +3,7 @@ Get the Git deploy key by either (a) running
   kubectl -n {{ .Release.Namespace }} logs deployment/{{ .Release.Name }} | grep identity.pub | cut -d '"' -f2
 
 or by (b) installing fluxctl through
-https://github.com/weaveworks/flux/blob/master/docs/fluxctl.md#installing-fluxctl
+https://github.com/weaveworks/flux/blob/master/docs/using/fluxctl.md#installing-fluxctl
 and running:
 
   fluxctl identity

deploy/flux-deployment.yaml

@@ -35,7 +35,7 @@ spec:
       # file, which you will need to do if you host your own git
       # repo rather than using github or the like. You'll also need to
       # mount it into the container, below. See
-      # https://github.com/weaveworks/flux/blob/master/docs/standalone-setup.md#using-a-private-git-host
+      # https://github.com/weaveworks/flux/blob/master/docs/install/standalone-setup.md#using-a-private-git-host
       # - name: ssh-config
       #   configMap:
       #     name: flux-ssh-config

docs/features/fluxyaml-config-files.md

@@ -26,7 +26,7 @@ Flux performs two types of actions on raw manifest files from the Git repository
 
 1. Read manifest files when performing a sync operation (i.e making sure that the status of the cluster reflects what's
    in the manifest files, adjusting it if necessary)
-2. Update the manifest files of [workload](https://github.com/weaveworks/flux/blob/master/docs/fluxctl.md#what-is-a-workload).
+2. Update the manifest files of [workload](https://github.com/weaveworks/flux/blob/master/docs/using/fluxctl.md#what-is-a-workload).
    Specifically, flux can update:
     * container images, when releasing a new image version. A release can happen manually or automatically, when a new
       container image is pushed to a repository.

docs/install/get-started.md

@@ -8,7 +8,7 @@ have Flux running in your cluster and it will be deploying any
 code changes for you.
 
 > **Note:** If you would like to install Flux using Helm, refer to the
-[Helm section](./helm-get-started.md).
+> [Helm section](./helm-get-started.md).
 
 ### Prerequisites
 
@@ -90,7 +90,7 @@ repository.
 
 Open GitHub, navigate to your fork, go to **Setting > Deploy keys**,
 click on **Add deploy key**, give it a `Title`, check **Allow write
-access**, paste the Flux public key and click **Add key**.  See the
+access**, paste the Flux public key and click **Add key**. See the
 [GitHub docs](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys)
 for more info on how to manage deploy keys.
 

docs/using/fluxctl.md

@@ -556,7 +556,7 @@ Commit customization
         --git-user
         --git-email
 
-        See [docs/daemon.md] for more information.
+        See [docs/features/daemon.md] for more information.
 
     3. Commit author
 

git/errors.go

@@ -16,7 +16,7 @@ We need to clone a git repo to proceed, and you haven't supplied
 one. Please upload a config file, including a git repository URL, as
 described in
 
-    https://github.com/weaveworks/flux/blob/master/docs/fluxctl.md
+    https://github.com/weaveworks/flux/blob/master/docs/using/fluxctl.md
 
 `,
 }

install/templates/flux-deployment.yaml.tmpl

@@ -36,7 +36,7 @@ spec:
       # file, which you will need to do if you host your own git
       # repo rather than using github or the like. You'll also need to
       # mount it into the container, below. See
-      # https://github.com/weaveworks/flux/blob/master/docs/standalone-setup.md#using-a-private-git-host
+      # https://github.com/weaveworks/flux/blob/master/docs/install/standalone-setup.md#using-a-private-git-host
       # - name: ssh-config
       #   configMap:
       #     name: flux-ssh-config

internal_docs/releasing.md

@@ -4,7 +4,7 @@ The release process needs to do these things:
 
  - create a new release on GitHub, with a tag
  - push Docker image(s) to Docker Hub
- - possibly upload the [`fluxctl` binaries](/docs/fluxctl.md#binary-releases) to the GitHub release
+ - possibly upload the [`fluxctl` binaries](/docs/using/fluxctl.md#binary-releases) to the GitHub release
  - make sure the version is entered into the checkpoint database so that up-to-date checks report back accurate information
  - close out the GitHub milestone that was used to track the release
 

remote/errors.go

@@ -22,7 +22,7 @@ and try the operation again.
 Otherwise, please consult the installation instructions in our
 documentation:
 
-    https://github.com/weaveworks/flux/blob/master/docs/installing.md
+    https://github.com/weaveworks/flux/blob/master/docs/install/index.md
 
 If you are still stuck, please log an issue:
 
@@ -89,7 +89,7 @@ Otherwise, it is likely to be an ongoing problem until fluxd is
 updated and/or redeployed. For help, please consult the installation
 instructions:
 
-    https://github.com/weaveworks/flux/blob/master/docs/installing.md
+    https://github.com/weaveworks/flux/blob/master/docs/install/index.md
 
 If you are still stuck, please log an issue: