More doc and landing page improvements

cloudfoundry · Jul 22, 2020 · 5741bf9 · 5741bf9
1 parent bcb5529
commit 5741bf9
Show file tree

Hide file tree

Showing 21 changed files with 164 additions and 81 deletions.
diff --git a/website/.gitignore b/website/.gitignore
@@ -18,3 +18,6 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+website/build
+website/site-dist
diff --git a/website/deploy.sh b/website/deploy.sh
@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+# Build and deploy the website
+
+set -euo pipefail
+
+# wesbite folder
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
+
+pushd $DIR > /dev/null
+echo "Building website ..."
+#npm run build
+
+msg="Website update: $(date)"
+
+if [ ! -d "./site-dist" ]; then
+  echo "Cloning website project"
+  git clone git@github.com:cf-stratos/website.git site-dist
+else
+  echo "Updating site checkout"
+  cd site-dist
+  git fetch
+  git reset --hard origin/master
+  git clean -fd
+  git rebase
+  cd ..
+fi
+
+echo "Copying newer site content ..."
+rsync -r ./build/ ./site-dist
+
+cd site-dist
+echo "Adding all files"
+git add -A
+git commit -m "${msg}"
+echo "Pushing changes ..."
+git push
+cd ..
+
+popd > /dev/null
diff --git a/...te/docs/guides/admin/invite-user-guide.md → website/docs/advanced/invite-user-guide.md b/...te/docs/guides/admin/invite-user-guide.md → website/docs/advanced/invite-user-guide.md
@@ -1,7 +1,6 @@
 ---
-id: invite-user-guide
-title: Invite User Guide
-sidebar_label: Invite Users 
+title: Configuring Invite User Support
+sidebar_label: Configuring User Invites
 ---
 
 Stratos provides a way for Cloud Foundry administrators and organization managers to invite users to an organization or space.

diff --git a/website/docs/guides/admin/sso.md → website/docs/advanced/sso.md b/website/docs/guides/admin/sso.md → website/docs/advanced/sso.md
@@ -1,7 +1,6 @@
 ---
-id: sso
-title: Single Sign On
-sidebar_label: Configure Single Sign On 
+title: Configuring Single Sign On
+sidebar_label: Configuring Single Sign On 
 ---
 
 By default, Stratos will authenticate against a UAA using username and password, for both logging into Stratos and when connecting Cloud Foundry endpoints.

diff --git a/website/docs/deploy/README.md b/website/docs/deploy/README.md
diff --git a/website/docs/deploy/all-in-one.md b/website/docs/deploy/all-in-one.md
@@ -1,7 +1,7 @@
 ---
 id: all-in-one
 title: Deploying with the All-In-One Docker Container
-sidebar_label: Deploy as Docker Container 
+sidebar_label: Docker All-in-One
 ---
 
 The all-in-one container sets up the Stratos components in a single container.

diff --git a/website/docs/deploy/cloud-foundry.md b/website/docs/deploy/cloud-foundry.md
@@ -6,7 +6,7 @@ sidebar_label: Deploy on Cloud Foundry
 
 ## Deployment Steps
 
-The quickest way to install Stratos is to deploy it as a Cloud Foundry application. 
+Stratos can be pushed as an application to Cloud Foundry. 
 
 You can do it in two ways:
 

diff --git a/website/docs/deploy/overview.md b/website/docs/deploy/overview.md
@@ -0,0 +1,15 @@
+---
+id: deploy-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)
+2. Kubernetes, using a Helm chart. See [guide](kubernetes)
+3. Docker, single container deploying all components. See [guide](all-in-one)
+
+> Note: that not all features are enabled in every environment - the Kubernetes deployment supports all features, but Cloud Foundry and Docker deployments do not support some features.
+
+> Note: Some features are marked as 'Tech Preview' and are only available if tech preview features are enabled when deploying.
diff --git a/...guides/troubleshooting/troubleshooting.md → website/docs/deploy/troubleshooting.md b/...guides/troubleshooting/troubleshooting.md → website/docs/deploy/troubleshooting.md
diff --git a/website/docs/guides/contribution/contributing.md b/website/docs/guides/contribution/contributing.md
@@ -1,7 +1,7 @@
 ---
 id: contributing
-title: Contributing to Stratos UI
-sidebar_label: Contributing to Stratos UI 
+title: Contributing to Stratos
+sidebar_label: Contributing to Stratos
 ---
 
 ## Reporting issues

diff --git a/website/docs/introduction.md b/website/docs/introduction.md
@@ -8,7 +8,7 @@ Stratos is an Open Source Web-based UI for Cloud Foundry and Kubernetes.
 
 For Cloud Foundry, it allows users and administrators to both manage applications running in the Cloud Foundry cluster and perform cluster management tasks.
 
-Fro Kubernetes, it provides Developers with views of their Kubernetes resources, the ability to vide and deploy Helm Charts and view Workloads.
+For Kubernetes, it provides Developers with views of their Kubernetes resources, the ability to vide and deploy Helm Charts and view Workloads.
 
 ![Stratos Application view](images/screenshots/app-summary.png)
 

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -1,12 +1,13 @@
 module.exports = {
   title: 'STRATOS',
-  tagline: 'A Rich Open-Source UI for Cloud Foundry and Kubernetes',
+  tagline: 'Open-Source Multi-Cluster UI for Cloud Foundry and Kubernetes',
   url: 'https://stratos.app',
   baseUrl: '/',
   favicon: 'img/favicon.ico',
   organizationName: 'cloudfoundry',
   projectName: 'stratos',
   themeConfig: {
+    disableDarkMode: true,
     navbar: {
       title: 'STRATOS',
       logo: {
@@ -89,4 +90,7 @@ module.exports = {
       },
     ],
   ],
+  stylesheets: [
+    //'https://fonts.googleapis.com/icon?family=Material+Icons'
+  ]
 };
diff --git a/website/package.json b/website/package.json
@@ -6,7 +6,7 @@
     "start": "docusaurus start",
     "build": "docusaurus build",
     "swizzle": "docusaurus swizzle",
-    "deploy": "docusaurus deploy"
+    "deploy": "./deploy.sh"
   },
   "dependencies": {
     "@docusaurus/core": "^2.0.0-alpha.58",

diff --git a/website/sidebars.js b/website/sidebars.js
@@ -1,8 +1,8 @@
 module.exports = {
   docs: {
-    Documentation: ['introduction', 'overview'],
-    'Getting Started': [
-    	'deploy/deploy-readme',
+		Documentation: ['introduction', 'overview'],
+    'Deploying Stratos': [
+			'deploy/deploy-overview',
     	{
     		"Cloud Foundry": [
     			'deploy/cloud-foundry',
@@ -16,35 +16,26 @@ module.exports = {
     		],
     	},
     	'deploy/all-in-one',
-    	'deploy/access'
+			'deploy/access',
+			'deploy/troubleshooting',
     ],
-    Guides: [
-    	{
-    		Contributing: [
-    			'guides/contribution/contributing',
-    			'guides/contribution/pull_request_template',
-    			'guides/contribution/issue_template'
-    		],
-    	},
-		'guides/customization/customizing',
-		{
-    		Developer: [
-    			'guides/developers/developers-guide',
-    			'guides/developers/developers-guide-env-tech',
-    			'guides/developers/developers-guide-e2e-tests'
-
-    		], 
-    	},
-		'guides/troubleshooting/troubleshooting',
-		{
-			Administrator: [
-				'guides/admin/invite-user-guide',
-				'guides/admin/sso'
-			],
+    'Advanced Topics': [
+			'advanced/invite-user-guide',
+			'advanced/sso'
+		],
+		'Contributing to Development': [
+			'guides/contribution/contributing',
+			{
+			Developer: [
+				'guides/developers/developers-guide',
+				'guides/developers/developers-guide-env-tech',
+				'guides/developers/developers-guide-e2e-tests'
+			]
 		}
 		],
 		'Extending Stratos': [
 			'extensions/introduction',
+			'guides/customization/customizing',
 			'extensions/theming',
 			'extensions/frontend',
 			'extensions/backend',

diff --git a/website/src/css/custom.css b/website/src/css/custom.css
@@ -25,7 +25,7 @@
   padding: 0 var(--ifm-pre-padding);
 }
 
-img.featureImage_src-pages- {
+img.feature-img {
   filter: grayscale(100%);
   height: 100px;
   width: 100px;
@@ -35,12 +35,7 @@ img.cf-logo {
   width: auto;
 }
 
-.navbar__items.navbar__items--right .react-toggle {
-  display: none;
-}
-
 .navbar {
-  /*background-color: #2196f3;*/
   background-color: #333;
 }
 
@@ -64,7 +59,7 @@ img.cf-logo {
   text-align: left;
 }
 
-.container .buttons_src-pages- {
+.container .get-started {
   justify-content: start;
   padding-top: 20px;
 }
@@ -104,7 +99,7 @@ img.cf-logo {
 }
 
 .home-intro {
-  margin-right: 150px;
+  /*margin-right: 150px;*/
 }
 
 .home-logo {
@@ -122,11 +117,17 @@ img.cf-logo {
 
 /* Screenshot */
 
-.screenshot-section {
+.blue {
   background-color: #2196f3;
   color: #fff
 }
 
+.white {
+  background-color: #fff;
+  color: #444;
+}
+
+
 .screenshot {
   display: flex;
   margin: 60px 0;
@@ -137,6 +138,13 @@ img.cf-logo {
   -webkit-box-shadow: 0px 0px 37px 15px rgba(20,20,20,0.75);
   -moz-box-shadow: 0px 0px 37px 15px rgba(20,20,20,0.75);
   box-shadow: 0px 0px 37px 15px rgba(20,20,20,0.75);  
+}
+
+.screenshot img.right {
+  margin-left: 60px;
+}
+
+.screenshot img.left {
   margin-right: 60px;
 }