Merge pull request #796 from CecileRobertMichon/docs-getting-started

 📖 Documentation updates

Author: k8s-ci-robot

docs/README.md

@@ -3,11 +3,17 @@
 ## Quick start
 
 - [Getting started](getting-started.md)
+- [Cluster API quick start](https://cluster-api.sigs.k8s.io/user/quick-start.html)
+
+## Features 
+
+ - [Topics](topics)
 
 ## Development
 
-- [Development instructions](development.md)
+- [Development guide](development.md)
+
+## Troubleshooting
 
-## Project Documentation
+- [Troubleshooting guide](troubleshooting.md)
 
-- [Design](design.md)

docs/clusterctl.md

@@ -69,15 +69,18 @@ An Azure Service Principal is needed for populating the controller manifests. Th
   4. Save the output from the above command in environment variables.
 
   ```bash
-  export AZURE_TENANT_ID=<Tenant>
-  export AZURE_CLIENT_ID=<AppId>
-  export AZURE_CLIENT_SECRET=<Password>
-  export AZURE_LOCATION="eastus"
+  export AZURE_TENANT_ID="<Tenant>"
+  export AZURE_CLIENT_ID="<AppId>"
+  export AZURE_CLIENT_SECRET='<Password>'
+  export AZURE_LOCATION="eastus" # this should be an Azure region that your subscription has quota for.
   ```
 
+:warning: NOTE: If your password contains single quotes (`'`), make sure to escape them. To escape a single quote, close the quoting before it, insert the single quote, and re-open the quoting. 
+For example, if your password is `foo'blah$`, you should do `export AZURE_CLIENT_SECRET='foo'\''blah$'`.
+
   5. Set the name of the AzureCloud to be used, the default value that would be used by most users is "AzurePublicCloud", other values are:
 
-  - ChinaCloud: "AzureChinaCloud"
+ - ChinaCloud: "AzureChinaCloud"
  - GermanCloud: "AzureGermanCloud"
  - PublicCloud: "AzurePublicCloud"
  - USGovernmentCloud: "AzureUSGovernmentCloud"
@@ -100,22 +103,12 @@ You can also [build your own image](https://image-builder.sigs.k8s.io/capi/provi
 
 ## Troubleshooting
 
-### Bootstrap running, but resources aren't being created
-
-Logs can be tailed using [`kubectl`][kubectl-logs]:
-
-```bash
-kubectl logs azure-provider-controller-manager-0 -n azure-provider-system -f
-```
+Please refer to the [troubleshooting guide][troubleshooting].
 
-### Resources are created but control plane is taking a long time to become ready
-
-You can check the custom script logs by SSHing into the VM created and reading `/var/lib/waagent/custom-script/download/0/{stdout,stderr}`.
-
-[development]: /docs/development.md
+[troubleshooting]: /docs/troubleshooting.md
 
 ## Building from master
 
 If you're interested in developing cluster-api-provider-azure and getting the latest version from `master`, please follow the [development guide][development].
 
-[kubectl-logs]: https://kubernetes.io/docs/reference/kubectl/cheatsheet/#interacting-with-running-pods
+[development]: /docs/development.md