Documentation tweaks

cloudfoundry · Jul 20, 2020 · 7181236 · 7181236
1 parent d26b948
commit 7181236
Show file tree

Hide file tree

Showing 9 changed files with 54 additions and 18 deletions.
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -28,4 +28,5 @@ exclude_patterns:
 - "**/vendor/"
 - "**/*.d.ts"
 - "**/__vendor/"
-- "**/*_test.go"
+- "**/*_test.go"
+- "website/"
diff --git a/.github/documentation.yml → .github/workflows/documentation.yml b/.github/documentation.yml → .github/workflows/documentation.yml
diff --git a/...docs/guides/extensions/backend-plugins.md → website/docs/extensions/backend.md b/...docs/guides/extensions/backend-plugins.md → website/docs/extensions/backend.md
@@ -1,7 +1,6 @@
 ---
-id: backend-plugins
 title: Backend Plugins
-sidebar_label: Backend 
+sidebar_label: Backend Plugins
 ---
 
 This document provides a brief outline for extending the Stratos backend (Jetstream).

diff --git a/.../guides/extensions/frontend-extensions.md → website/docs/extensions/frontend.md b/.../guides/extensions/frontend-extensions.md → website/docs/extensions/frontend.md
@@ -1,7 +1,6 @@
 ---
-id: frontend-extensions
-title: Front-end Extensions
-sidebar_label: Frontend 
+title: Frontend Extensions
+sidebar_label: Frontend Extensions
 ---
 
 An example illustrating the various front-end extension points of Stratos is included in the folder `examples/custom-src`.

diff --git a/website/docs/extensions/introduction.md b/website/docs/extensions/introduction.md
@@ -0,0 +1,5 @@
+---
+title: Extending Stratos
+sidebar_label: Introduction
+---
+This document is in progress
diff --git a/website/docs/extensions/theming.md b/website/docs/extensions/theming.md
@@ -0,0 +1,5 @@
+---
+title: Theming Stratos
+sidebar_label: Theming Stratos
+---
+This document is in progress
diff --git a/website/docs/introduction.md b/website/docs/introduction.md
@@ -1,14 +1,14 @@
 ---
 id: introduction
-title: Stratos
+title: STRATOS
 sidebar_label: Introduction 
 ---
 
-Stratos is an Open Source Web-based UI (Console) for managing Cloud Foundry. It allows users and administrators to both manage applications running in the Cloud Foundry cluster and perform cluster management tasks.
+Stratos is an Open Source Web-based UI for Cloud Foundry and Kubernetes.
 
-If you are looking for a version of Stratos, you can find ..
-- V1 in the [v1-master](https://github.com/cloudfoundry/stratos/tree/v1-master) branch.
-- V2 in the [v2-master](https://github.com/cloudfoundry/stratos/tree/v2-master) branch.
+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.
 
 ![Stratos Application view](images/screenshots/app-summary.png)
 

diff --git a/website/sidebars.js b/website/sidebars.js
@@ -34,10 +34,6 @@ module.exports = {
     			'guides/developers/developers-guide-e2e-tests'
 
     		], 
-    		Extensions: [
-    			'guides/extensions/frontend-extensions',
-    			'guides/extensions/backend-plugins'
-    		],
     	},
 		'guides/troubleshooting/troubleshooting',
 		{
@@ -46,6 +42,13 @@ module.exports = {
 				'guides/admin/sso'
 			],
 		}
-    ],
+		],
+		'Extending Stratos': [
+			'extensions/introduction',
+			'extensions/theming',
+			'extensions/frontend',
+			'extensions/backend',
+		],
+
   },
 };
diff --git a/website/src/css/custom.css b/website/src/css/custom.css
@@ -76,5 +76,29 @@ img.cf-logo {
 /* Reduce the text sizes */
 
 #__docusaurus article h1 {
-  font-size: 32px;
-}
+  font-size: 28px;
+}
+
+#__docusaurus article h2 {
+  font-size: 24px;
+}
+
+#__docusaurus article h3 {
+  font-size: 20px;
+}
+
+#__docusaurus article h4 {
+  font-size: 18px;
+}
+
+.menu__list, .menu__link {
+  font-size: 14px;
+}
+
+#__docusaurus .menu .menu__link--sublist:after {
+  background-size: 1.25rem 1.25rem;
+}
+
+#__docusaurus .docSidebarContainer_node_modules-\@docusaurus-theme-classic-src-theme-DocPage- {
+  width: 280px;
+}