INT-3729 - Stratos - Website: Update Docusaurus to nearest stable (#111

)

* Working 2.0.1 🎉

* Fix broken links

* fix small mistake with sed

* fix sed expression

* fix indent

website/build-versions.sh

@@ -48,6 +48,21 @@ function createVersionedDocs() (
   label=$3
 
   mkdir -p $currentWebsite/versioned_docs
+
+  # Workaround for broken links in versions 4.4.0 and before
+  printf '%s\n%s\n' "$target_version" "$version" | sort -V | head -n1
+  if [[ $? -eq 0 ]]; then
+      logInner "Version is 4.4.0 or less, applying workaround for broken links"
+      gnu_sed=sed
+      if [[ "$(uname)" == "Darwin" ]]; then
+        gnu_sed=gsed
+      fi
+      echo $gnu_sed
+      find $checkedOutRepo/website/versioned_docs/version-$label -type f -name "*.md" -exec ${gnu_sed} -i 's/cloud-foundry\/cloud-foundry/cloud-foundry\/cloud-foundry.md/g' {} \;
+      find $checkedOutRepo/website/versioned_docs/version-$label -type f -name "*.md" -exec ${gnu_sed} -i 's/](cloud-foundry)/(cloud-foundry.md)/g' {} \;
+  fi
+  # End of workaround
+
   cp -r $checkedOutRepo/website/versioned_docs/version-$label $currentWebsite/versioned_docs
 )
 

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](cloud-foundry) Stratos, when deployed via `cf push`,
+As described in the standard `cf push` instructions [here](cloud-foundry.md) 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.

website/docs/deploy/overview.md

@@ -8,7 +8,7 @@ sidebar_label: Overview
 
 Stratos can be deployed in the following environments:
 
-1. Cloud Foundry, as an application. See [guide](cloud-foundry/cloud-foundry)
+1. Cloud Foundry, as an application. See [guide](cloud-foundry/cloud-foundry.md)
 2. Kubernetes, using a Helm chart. See [guide](kubernetes)
 3. Docker, single container deploying all components. See [guide](all-in-one)
 
@@ -20,7 +20,7 @@ Not all features are enabled in every environment - the Kubernetes deployment su
 
 In this case, Stratos is deployed in a manner optimized for the management of a single Cloud Foundry instance.
 
-For more information see the [guide](cloud-foundry/cloud-foundry).
+For more information see the [guide](cloud-foundry/cloud-foundry.md).
 
 ### Deployed in Kubernetes
 

website/docs/endpoints/cf/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/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.md)  have been followed, you will not follow these steps for the default CF.
 
 ## Configuration for CF Push
 

website/docs/introduction.md

@@ -1,6 +1,7 @@
 ---
 id: introduction
 title: Introduction
+slug: /
 sidebar_label: Introduction 
 ---
 
@@ -14,7 +15,7 @@ For Kubernetes, it provides Developers with views of their Kubernetes resources,
 
 ## Quick Start
 
-To get started quickly, we recommend following the steps to deploy the Stratos Console as a Cloud Foundry Application - see [here](deploy/cloud-foundry/cloud-foundry).
+To get started quickly, we recommend following the steps to deploy the Stratos Console as a Cloud Foundry Application - see [here](deploy/cloud-foundry).
 
 If you have [docker](https://www.docker.com/community-edition) installed, you can quickly deploy Stratos using the all-in-one container:
 
@@ -28,7 +29,7 @@ Once that has finished, you can then access Stratos by visiting https://localhos
 
 Stratos can be deployed in the following environments:
 
-1. Cloud Foundry, as an application. See [guide](deploy/cloud-foundry/cloud-foundry)
+1. Cloud Foundry, as an application. See [guide](deploy/cloud-foundry/cloud-foundry.md)
 2. Kubernetes, using a Helm chart. See [guide](deploy/kubernetes)
 3. Docker, single container deploying all components. See [guide](deploy/all-in-one)
 

website/docusaurus.config.js

@@ -5,6 +5,8 @@ module.exports = {
   baseUrl: '/',
   favicon: 'img/favicon.ico',
   organizationName: 'cloudfoundry',
+  onBrokenLinks: 'warn',
+  onBrokenMarkdownLinks: 'warn',
   projectName: 'stratos',
   themeConfig: {
     navbar: {
@@ -19,7 +21,7 @@ module.exports = {
         nextVersionLabel: 'Latest',
       },
       {
-        to: 'docs/',
+        to: 'docs/introduction',
         activeBasePath: 'docs',
         label: 'Docs',
         position: 'right',
@@ -35,7 +37,7 @@ module.exports = {
         title: 'Docs',
         items: [{
           label: 'Getting Started',
-          to: 'docs/',
+          to: 'docs/introduction',
         },
         {
           label: 'Deploying Stratos',
@@ -70,16 +72,6 @@ module.exports = {
       defaultMode: 'light',
       disableSwitch: false,
       respectPrefersColorScheme: true,
-      switchConfig: {
-        darkIcon: '🌙',
-        darkIconStyle: {
-          marginLeft: '2px',
-        },
-        lightIcon: '☀️',
-        lightIconStyle: {
-          marginLeft: '1px',
-        },
-      },
     },
   },
   presets: [
@@ -88,7 +80,6 @@ module.exports = {
       {
         docs: {
           // It is recommended to set document id as docs home page (`docs/` path).
-          homePageId: 'introduction',
           sidebarPath: require.resolve('./sidebars.js'),
           // Please change this to your repo.
           editUrl: 'https://github.com/cloudfoundry/stratos/edit/master/website/',