* Fix broken links due to reorganization of documents

* Move Troubleshooting content from cloud-foundry deployment doc to cf-troubleshooting
cloudfoundry · richard-cox · Aug 7, 2020 · Jul 13, 2020 · Jul 13, 2020 · Jul 20, 2020
commit f65909930645c9d07c28ebd6aa7184d33084790c
diff --git a/website/docs/advanced/invite-user-guide.md b/website/docs/advanced/invite-user-guide.md
@@ -59,7 +59,7 @@ This action must be performed by an Administrator in Stratos.
 1) Use the `Configure` button in the `User Invitation Support` section.
 1) Supply the uaa client id and secret and click `Configure`
 
-> Note: If Stratos has been deployed via `cf push` and the steps under the `Pre-configure invite UAA client` header in the  [CF deploy guide](../../deploy/cloud-foundry)  have been followed, you will not follow these steps for the default CF.
+> Note: If Stratos has been deployed via `cf push` and the steps under the `Pre-configure invite UAA client` header in the  [CF deploy guide](../deploy/cloud-foundry/cloud-foundry)  have been followed, you will not follow these steps for the default CF.
 
 ## Configuration for CF Push
 
@@ -145,7 +145,7 @@ When developing locally, we recommend using [mailcatcher](https://mailcatcher.me
 
 To install mailcatcher via docker, use the following command: `docker run -d -p 1080:80 -p 1025:25 --name mail tophfr/mailcatcher`. Once mailcatcher is installed, continue to follow the instructions below.
 
-SMTP server details can be set via rhe usual environment variable approach or, when running locally, in the `jetstream/config.properties` file (see Backend Development - Configuration in [developers-guide](../developers/developers-guide)). The config settings, with example values, are as follows:
+SMTP server details can be set via rhe usual environment variable approach or, when running locally, in the `jetstream/config.properties` file (see Backend Development - Configuration in [developers-guide](../developer/introduction)). The config settings, with example values, are as follows:
 
 ```
 SMTP_FROM_ADDRESS=Stratos<test@test.com>

diff --git a/website/docs/deploy/cloud-foundry/cf-troubleshooting.md b/website/docs/deploy/cloud-foundry/cf-troubleshooting.md
@@ -56,3 +56,102 @@ If you have problems when deploying Stratos as a Cloud Foundry application, chec
 For information on the default ASGs, see [here](https://docs.cloudfoundry.org/concepts/asg.html#default-asg).
 
 To configure a new ASG for the organization and space that are using Stratos, first create a new ASG definition, for example:
+
+```
+[
+   {
+      "destination":"0.0.0.0-255.255.255.255",
+      "protocol":"all"
+   }
+]
+```
+
+Save this to a file, e.g. `my-asg.json`.
+
+> Note: this allows example all network traffic on all IP ranges - we don't recommend using this.
+
+Unbind the existing ASG for you organization (`ORG`) and space (`SPACE`) with:
+
+```
+cf unbind-security-group public_networks ORG SPACE
+```
+
+Create a new ASG using the definition you saved to a file and give it a name, with:
+
+```
+cf create-security-group NAME my-asg.json
+```
+
+Bind this ASG to your `ORG` and `SPACE` with:
+
+```
+cf bind-security-group NAME ORG SPACE
+```
+
+
+## Console fails to start
+
+The Stratos Console will automatically detect the API endpoint for your Cloud Foundry. To do so, it relies on the `cf_api` value inside the `VCAP_APPLICATION` environment variable.
+To check if the variable is present, use the CF CLI to list environment variables, and inspect the `VCAP_APPLICATION` variable under `System-Provided`.
+
+```
+$ cf env console
+Getting env variables for app console in org SUSE / space dev as admin...
+OK
+
+System-Provided:
+
+
+ {
+  "VCAP_APPLICATION": {
+   "application_id": ...,
+   "application_name": "console",
+   "application_uris": ...
+   "application_version": ...,
+   "cf_api": "http://api.cf-dev.io",
+   ...
+ }
+
+ No user-defined env variables have been set
+ ...
+```
+
+If the `cf_api` environment variable is absent then set the `CF_API_URL` variable. See the following _Setting the `CF_API_URL` env variable in the manifest_ section.
+
+
+However, if the `cf_api` environment variable is present, and an HTTP address is specified, it is possible that insecure traffic may be blocked. See the following _Setting the `CF_API_FORCE_SECURE` env variable in the manifest_ section.
+
+
+#### Setting the `CF_API_URL` env variable in the manifest
+
+To specify the Cloud Foundry API endpoint, add the `CF_API_URL` variable to the manifest, for example:
+
+```
+applications:
+- name: console
+  memory: 256M
+  disk_quota: 256M
+  host: console
+  timeout: 180
+  buildpack: https://github.com/cloudfoundry/stratos-buildpack
+  health-check-type: port
+  env:
+    CF_API_URL: https://<<CLOUD FOUNDRY API ENDPOINT>>>
+```
+
+#### Setting the `CF_API_FORCE_SECURE` env variable in the manifest
+
+To force the console to use secured communication with the Cloud Foundry API endpoint (HTTPS rather than HTTP), specify the `CF_API_FORCE_SECURE` environment in the manifest, for example:
+
+```
+applications:
+- name: console
+  memory: 256M
+  disk_quota: 256M
+  host: console
+  timeout: 180
+  buildpack: https://github.com/cloudfoundry/stratos-buildpack
+  health-check-type: port
+  env:
+    CF_API_FORCE_SECURE: true
+```
diff --git a/website/docs/deploy/cloud-foundry/cloud-foundry.md b/website/docs/deploy/cloud-foundry/cloud-foundry.md
@@ -19,9 +19,9 @@ You will then be able to open a web browser and navigate to the console URL:
 
 Where `<DOMAIN>` is the default domain configured for your Cloud Foundry cluster.
 
-To login use the following credentials detailed [here](access.md).
+To login use the following credentials detailed [here](../access).
 
-If you run into issues, please refer to the [Troubleshooting Guide](#troubleshooting) below.
+If you run into issues, please refer to the [Troubleshooting Guide](cf-troubleshooting) below.
 
 > The console will pre-configure the host Cloud Foundry endpoint. No other CF instance should be registered unless the instructions in
  the section [Associate Cloud Foundry database service](#associate-cloud-foundry-database-service) are followed.
@@ -159,104 +159,4 @@ applications:
 
 When SSO Login is enabled, Stratos will also auto-connect to the Cloud Foundry it is deployed in using the token obtained during the SSO Login flow.
 
-For more information - see [Single-Sign On](../guides/admin/sso).
-
-```
-[
-   {
-      "destination":"0.0.0.0-255.255.255.255",
-      "protocol":"all"
-   }
-]
-```
-
-Save this to a file, e.g. `my-asg.json`.
-
-> Note: this allows example all network traffic on all IP ranges - we don't recommend using this.
-
-Unbind the existing ASG for you organization (`ORG`) and space (`SPACE`) with:
-
-```
-cf unbind-security-group public_networks ORG SPACE
-```
-
-Create a new ASG using the definition you saved to a file and give it a name, with:
-
-```
-cf create-security-group NAME my-asg.json
-```
-
-Bind this ASG to your `ORG` and `SPACE` with:
-
-```
-cf bind-security-group NAME ORG SPACE
-```
-
-
-### Console fails to start
-
-The Stratos Console will automatically detect the API endpoint for your Cloud Foundry. To do so, it relies on the `cf_api` value inside the `VCAP_APPLICATION` environment variable.
-To check if the variable is present, use the CF CLI to list environment variables, and inspect the `VCAP_APPLICATION` variable under `System-Provided`.
-
-```
-$ cf env console
-Getting env variables for app console in org SUSE / space dev as admin...
-OK
-
-System-Provided:
-
-
- {
-  "VCAP_APPLICATION": {
-   "application_id": ...,
-   "application_name": "console",
-   "application_uris": ...
-   "application_version": ...,
-   "cf_api": "http://api.cf-dev.io",
-   ...
- }
-
- No user-defined env variables have been set
- ...
-```
-
-If the `cf_api` environment variable is absent then set the `CF_API_URL` variable. See the following _Setting the `CF_API_URL` env variable in the manifest_ section.
-
-
-However, if the `cf_api` environment variable is present, and an HTTP address is specified, it is possible that insecure traffic may be blocked. See the following _Setting the `CF_API_FORCE_SECURE` env variable in the manifest_ section.
-
-
-#### Setting the `CF_API_URL` env variable in the manifest
-
-To specify the Cloud Foundry API endpoint, add the `CF_API_URL` variable to the manifest, for example:
-
-```
-applications:
-- name: console
-  memory: 256M
-  disk_quota: 256M
-  host: console
-  timeout: 180
-  buildpack: https://github.com/cloudfoundry/stratos-buildpack
-  health-check-type: port
-  env:
-    CF_API_URL: https://<<CLOUD FOUNDRY API ENDPOINT>>>
-```
-
-#### Setting the `CF_API_FORCE_SECURE` env variable in the manifest
-
-To force the console to use secured communication with the Cloud Foundry API endpoint (HTTPS rather than HTTP), specify the `CF_API_FORCE_SECURE` environment in the manifest, for example:
-
-```
-applications:
-- name: console
-  memory: 256M
-  disk_quota: 256M
-  host: console
-  timeout: 180
-  buildpack: https://github.com/cloudfoundry/stratos-buildpack
-  health-check-type: port
-  env:
-    CF_API_FORCE_SECURE: true
-```
-
+For more information - see [Single-Sign On](../../advanced/sso).
diff --git a/website/docs/deploy/cloud-foundry/db-migration.md b/website/docs/deploy/cloud-foundry/db-migration.md
@@ -4,7 +4,7 @@ title: Associate a Cloud Foundry database service
 sidebar_label: Database service bindings
 ---
 
-As described in the standard `cf push` instructions [here](../deploy-readme) Stratos, when deployed via `cf push`,
+As described in the standard `cf push` instructions [here](cloud-foundry) Stratos, when deployed via `cf push`,
 does not contain any way to persist data over application restarts and db entries such as registered endpoints
 and user tokens are lost. To resolve this a Cloud Foundry db service can be bound to to it. Run through
 the steps below to implement.

diff --git a/website/docs/deploy/kubernetes.md b/website/docs/deploy/kubernetes.md
@@ -16,4 +16,4 @@ You will need to have both the `kubectl` and `helm` CLIs installed and available
 
 The Stratos Helm chart contains a `README.md` file that contains installation instructions and configuration documentation.
 
-This document is also available in [here](helm-installation).
+This document is also available in [here](kubernetes/helm-installation).
diff --git a/website/docs/deploy/overview.md b/website/docs/deploy/overview.md
@@ -1,12 +1,12 @@
 ---
-id: deploy-overview
+id: overview
 title: Deploying Stratos
 sidebar_label: Overview
 ---
 
 Stratos can be deployed in the following environments:
 
-1. Cloud Foundry, as an application. See [guide](cloud-foundry)
+1. Cloud Foundry, as an application. See [guide](cloud-foundry/cloud-foundry)
 2. Kubernetes, using a Helm chart. See [guide](kubernetes)
 3. Docker, single container deploying all components. See [guide](all-in-one)
 
@@ -27,7 +27,7 @@ In this case, the front-end web application static resources are served by the A
 
 By defaut, a non-persistent SQLite database is used - by automatically registering the cloud foundry endpoint and connecting to it on login, all data stored in the database can be treated as ephimeral, since it will be re-created next time a user logs in. Cloud Foundry Session Affinity is used to ensure that when scaling up the Console Application to multiple instances, the user is also directed to the instance which will know about them and their endpoints (since each Application instance will have its own local SQLite store).
 
-Alternatively, Stratos can be configured [with a persistent Cloud Foundry database service](deploy/cloud-foundry/db-migration), which enables features requiring persistence such as user favorites.
+Alternatively, Stratos can be configured [with a persistent Cloud Foundry database service](cloud-foundry/db-migration), which enables features requiring persistence such as user favorites.
 
 ## Deployed in Kubernetes
 

diff --git a/website/docs/deploy/troubleshooting.md b/website/docs/deploy/troubleshooting.md
@@ -5,7 +5,7 @@ sidebar_label: Troubleshooting
 ---
 
 ## Deploying as a Cloud Foundry Application
-See the custom troubleshooting guide [here](../../deploy/cloud-foundry#troubleshooting).
+See the custom troubleshooting guide [here](cloud-foundry/cf-troubleshooting).
 
 ## Usernames appear as long random characters when connected to IBM Cloud
 

diff --git a/website/docs/developer/backend.md b/website/docs/developer/backend.md
@@ -3,9 +3,6 @@ title: Backend Development
 sidebar_label: Overview
 ---
 
-
-## Backend Development
-
 Jetstream is the back-end for Stratos. It is written in Go.
 
 We use Go Modules for dependency management.

diff --git a/website/docs/developer/developers-guide-e2e-tests.md b/website/docs/developer/developers-guide-e2e-tests.md
@@ -28,9 +28,9 @@ The tests require an instance of Cloud Foundry with the following:
 - A number of other Cloud Foundry entities
 
 To meet the above requirements we recommend running the Stratos CF E2E set up script which is kept up to date with the latest test requirements.
-More information can be found [below](#Running-the-E2E-Set-up-Script)
+More information can be found [below](#running-the-e2e-set-up-script)
 
-Before running the E2E tests, you need to create a file named `secrets.yaml` in the root of the Stratos folder. An example template is included in [src/test-e2e/secrets.yaml.example](../src/test-e2e/secrets.yaml.example) - copy this to `secrets.yaml` and edit accordingly.
+Before running the E2E tests, you need to create a file named `secrets.yaml` in the root of the Stratos folder. An example template is included in [src/test-e2e/secrets.yaml.example](https://github.com/cloudfoundry/stratos/blob/master/src/test-e2e/secrets.yaml.example) - copy this to `secrets.yaml` and edit accordingly.
 
 If you want to run the tests in headless Chrome, add the following to the secrets file:
 
@@ -39,7 +39,7 @@ headless: true
 ```
 
 ## Running the E2E Set up Script
-The script can be found in [deploy/tools/init-cf-for-e2e.sh](../deploy/tools/init-cf-for-e2e.sh)
+The script can be found in [deploy/tools/init-cf-for-e2e.sh](https://github.com/cloudfoundry/stratos/blob/master/deploy/tools/init-cf-for-e2e.sh)
 
 ### Minimum Requirements
 - CF CLI
@@ -111,7 +111,7 @@ Given the output of the script, the following template can be used to update the
 
 ### Tidying up test generated CF entities
 If tests are stopped before completing or fail to clean old test artifacts will exist in the CF. To clean some of these please see the script
-at [deploy/ci/automation/e2e-clean-remnants.sh](../deploy/ci/automation/e2e-clean-remnants.sh)
+at [deploy/ci/automation/e2e-clean-remnants.sh](https://github.com/cloudfoundry/stratos/blob/master/deploy/ci/automation/e2e-clean-remnants.sh)
 
 ## Running the tests
 

diff --git a/website/docs/developer/frontend.md b/website/docs/developer/frontend.md
@@ -13,10 +13,10 @@ using Visual Studio Code. If you feel comfortable with these and are happy with
 ## Set up Dependencies
 
 * Set up a Stratos backend - The frontend cannot run without a backend. Both backend and frontend exist in this same repo.
-  * Don't need to make changes to the backend code? To set up a backend run through the [deploy section](https://github.com/cloudfoundry/stratos/blob/master/deploy/README.md),
+  * Don't need to make changes to the backend code? To set up a backend run through the [deploy section](../deploy/overview),
     choose a deployment method and bring one up. These deployments will bring up the entire backend, including api service and database
     along with a V2 frontend.
-  * Need to make changes to the backend code? Follow the below [Backend Development](#Backend-Development) set up guide
+  * Need to make changes to the backend code? Follow the [Backend Development](backend) set up guide
 * Install [NodeJs](https://nodejs.org) (minimum node version 12.13.0)
 * Install [Angular CLI](https://cli.angular.io/) - `npm install -g @angular/cli`
 
@@ -27,7 +27,7 @@ Configuration information can be found in two places
 * `./proxy.conf.js`
   * In new forks this is missing and needs to be created using `./proxy.conf.template.js` as a template.
   * Contains the address of the backend. Which will either be...
-     * If the backend is deployed via the instructions in the [deploy section](https://github.com/cloudfoundry/stratos/blob/master/deploy/README.md)
+     * If the backend is deployed via the instructions in the [deploy section](../deploy/overview)
        the url will be the same address as the V1 console's frontend address. For instance `https://localhost` would translate to
         ```
         const PROXY_CONFIG = {
@@ -42,7 +42,7 @@ Configuration information can be found in two places
           "ws": true,
         }
         ```
-      * If the backend is running locally using the instructions [Backend Development](#Backend-Development) below the url will local host
+      * If the backend is running locally using the instructions in [Backend Development](backend), the url will local host
         with a port of the `CONSOLE_PROXY_TLS_ADDRESS` value from `src/jetstream/config.properties`. By default this will be 5445. For
         instance
         ```

diff --git a/website/docs/developer/introduction.md b/website/docs/developer/introduction.md
@@ -4,8 +4,8 @@ sidebar_label: Stratos Development
 ---
 
 1. [Introduction](#introduction)
-1. [Frontend Development](#frontend-development)
-1. [Backend Development](#backend-development)
+1. [Frontend Development](frontend)
+1. [Backend Development](backend)
 
 ## Introduction
 

diff --git a/website/docs/extensions/customizing.md b/website/docs/extensions/customizing.md
@@ -130,7 +130,7 @@ We currently expose the following extension points in Stratos:
 
 We use Decorators to annotate components to indicate that they are Stratos extensions.
 
-See [Extensions](../extensions/frontend-extensions) for more detail and examples of front-end extensions.
+See [Extensions](../extensions/frontend) for more detail and examples of front-end extensions.
 
 
 ### Changing the Initial Loading Indicator

diff --git a/website/docs/extensions/frontend.md b/website/docs/extensions/frontend.md
@@ -13,7 +13,7 @@ Next, run the customization script (this is done automatically when you do an `n
 npm run customize
 ```
 
-You can now run Stratos locally to see the customizations - see the [Developer's Guide](../developers/developers-guide) for details.
+You can now run Stratos locally to see the customizations - see the [Developer's Guide](../developer/frontend) for details.
 
 For a walk-through of extending Stratos, see [Example: Adding a Custom Tab](#example-adding-a-custom-tab).
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,4 +16,4 @@ You will need to have both the `kubectl` and `helm` CLIs installed and available

		The Stratos Helm chart contains a `README.md` file that contains installation instructions and configuration documentation.

		This document is also available in [here](helm-installation).
		This document is also available in [here](kubernetes/helm-installation).