Merge pull request #574 from devspace-cloud/improve-docs

Docs: enable search and improve nav structure and styling

README.md

@@ -124,10 +124,10 @@ devspace analyze
 
 Learn more about development with DevSpace:
 
-- [Automate issue detection with DevSpace](https://devspace.cloud/docs/workflow-basics/debugging/analyze)
-- [Stream container logs with DevSpace](https://devspace.cloud/docs/workflow-basics/debugging/logs)
-- [Start terminal sessions for debugging](https://devspace.cloud/docs/workflow-basics/debugging/enter)
-- [Use the debugger of your IDE with DevSpace](https://devspace.cloud/docs/workflow-basics/debugging/remote-debuggers)
+- [Automate issue detection with DevSpace](https://devspace.cloud/docs/workflow-basics/development/analyze)
+- [Stream container logs with DevSpace](https://devspace.cloud/docs/workflow-basics/development/logs)
+- [Start terminal sessions for debugging](https://devspace.cloud/docs/workflow-basics/development/enter)
+- [Use the debugger of your IDE with DevSpace](https://devspace.cloud/docs/workflow-basics/development/remote-debuggers)
 
 </details>
 

docs/pages/getting-started/deployment.md

@@ -185,5 +185,4 @@ Learn how to [connect custom domains](/docs/cloud/spaces/domains).
 ## What's next?
 DevSpace CLI does more than simplify and streamline the process of deploying applications to Kubernetes. It also lets you:
 - [Develop applications directly inside a Kubernetes cluster](/docs/getting-started/development)
-- [Debug and analyze deployed applications](/docs/getting-started/debugging)
 - [Example Configurations](https://github.com/devspace-cloud/devspace/tree/master/examples)

docs/pages/image-building/cleanup.md

@@ -1,15 +1,15 @@
 ---
-title: Cleanup built images
+title: Cleanup images locally
 ---
 
-When using docker for image building, local space can get sparse after a lot of docker builds. DevSpace provides a convenient command to clean up all images that were created by DevSpace locally. This command does not remove any pushed images remotely and just clears local images and space.
+When using Docker for image building, disk space on your local computer can get sparse after a lot of Docker builds. DevSpace provides a convenient command to clean up all images that were built with your local Docker daemon using DevSpace DevSpace CLI. This command does not remove any pushed images remotely and just clears local images and space.
 
 In order to cleanup all created images locally, simply run the following command in your project folder:
 ```bash
 devspace cleanup images
 ```
 
-In addition it also makes sense to prune your docker environment to free additional space with the following command:
+In addition it also makes sense to prune your Docker environment to free additional space with the following command:
 
 ```bash
 docker system prune

docs/pages/image-building/tagging.md

@@ -1,5 +1,5 @@
 ---
-title: Tagging images
+title: Define image tags
 ---
 
 If you have any image defined in your `devspace.yaml`, DevSpace will tag this image after building with a random string and push it to the defined registry. DevSpace will then replace the image name with the just build tag in memory in the resources that should be deployed (kubernetes manifests, helm chart values or component values).  

docs/pages/workflow-basics/deployment/ci-cd-pipelines.md

@@ -0,0 +1,15 @@
+---
+title: CI/CD Integration
+---
+
+DevSpace CLI is able to run in non-interactive environments such as in CI/CD pipelines. This allows you to use the DevSpace configuration not only for development but also for spinning up test environments and updating your staging or production system with automated deployment scripts that use DevSpace CLI.
+
+## Login with an Access Key
+To use DevSpace Cloud in CI/CD pipelines, you need to use access keys for authentication. To create a new access key navigate to `Settings -> Access Keys` in the DevSpace Cloud UI and click on the `Create Key` button. Follow the instructions on the screen and copy the newly created access key.  
+
+In your CI/CD pipeline, you can now login into your account with: 
+```bash
+devspace login --key=ACCESS_KEY
+```
+
+After running the above command for authentication with an access key, you can use the usual DevSpace commands within your CI/CD pipeline, e.g. `devspace create space`, `devspace use space` and `devspace remove space`.  

docs/pages/workflow-basics/deployment/domains.md

@@ -1,5 +1,5 @@
 ---
-title: Ingresses
+title: Domains & Ingresses
 ---
 
 In Kubernetes, traffic from outside the cluster is being routed like this:

docs/pages/workflow-basics/debugging/logs.md → docs/pages/workflow-basics/development/logs.md

@@ -1,5 +1,5 @@
 ---
-title: View logs
+title: View container logs
 ---
 
 To view the logs of a container, run this command:

docs/pages/workflow-basics/debugging/sync.md → docs/pages/workflow-basics/development/sync.md

@@ -1,8 +1,8 @@
 ---
-title: Synchronize Files from running pods
+title: Synchronize files on-demand
 ---
 
-DevSpace CLI is able to synchronize files from the local computer into a running pod. This can be useful during development or debugging to change container files on the fly without doing constant `kubectl cp`.  
+DevSpace CLI is able to synchronize files from the local computer into any running pod on-demand. This can be useful for debugging to change container files on the fly without constantly running `kubectl cp` after every file change.  
 
 Run the following command to start syncing files between the local computer
 ```bash

docs/website/sidebars.json

@@ -10,21 +10,20 @@
       "workflow-basics/containerization",
       "workflow-basics/deployment",
       "workflow-basics/deployment/domains",
-      "workflow-basics/deployment/access-keys",
-      "workflow-basics/dependencies",
+      "workflow-basics/deployment/ci-cd-pipelines",
+      "workflow-basics/deployment/dependencies",
       "workflow-basics/development",
-      "workflow-basics/debugging",
-      "workflow-basics/debugging/analyze",
-      "workflow-basics/debugging/sync",
-      "workflow-basics/debugging/enter",
-      "workflow-basics/debugging/logs",
-      "workflow-basics/debugging/remote-debuggers"
+      "workflow-basics/development/analyze",
+      "workflow-basics/development/logs",
+      "workflow-basics/development/enter",
+      "workflow-basics/development/sync",
+      "workflow-basics/development/remote-debuggers"
     ],
     "Build Images": [
       "image-building/overview",
       "image-building/add-images",
-      "image-building/tagging",
       "image-building/remove-images",
+      "image-building/tagging",
       "image-building/cleanup",
       "image-building/specification",
       "image-building/registries/authentication",

docs/website/siteConfig.js

@@ -10,34 +10,35 @@
 
 const siteConfig = {
   projectName: "devspace-docs",
-  title: 'DevSpace Documentation', // Title for your website.
-  tagline: 'A website for testing',
-  url: 'https://devspace.cloud', // Your website URL
-  baseUrl: '/',
+  title: "DevSpace Documentation", // Title for your website.
+  tagline: "A website for testing",
+  url: "https://devspace.cloud", // Your website URL
+  baseUrl: "/",
 
   // For no header links in the top nav bar -> headerLinks: [],
   headerLinks: [
-    {href: 'http://devspace.cloud/pricing', label: 'Pricing'},
-    {href: 'http://devspace.cloud/about', label: 'About'},
-    {doc: 'getting-started/installation', label: 'Docs'},
-    {href: 'http://devspace.cloud/help', label: 'Help'},
-    {href: 'https://app.devspace.cloud/', label: 'Login'},
-    {href: '#', label: ''},
+    { href: "http://devspace.cloud/pricing", label: "Pricing" },
+    { href: "http://devspace.cloud/about", label: "About" },
+    { doc: "getting-started/installation", label: "Docs" },
+    { href: "http://devspace.cloud/help", label: "Help" },
+    { href: "https://app.devspace.cloud/", label: "Login" },
+    { href: "#", label: "" },
+    { search: true }
   ],
 
   /* path to images for header/footer */
-  headerIcon: 'img/devspace-logo.svg',
-  footerIcon: 'img/devspace-logo.svg',
-  favicon: 'img/favicon.png',
+  headerIcon: "img/devspace-logo.svg",
+  footerIcon: "img/devspace-logo.svg",
+  favicon: "img/favicon.png",
 
   // Open Graph and Twitter card images.
-  ogImage: 'img/devspace-logo.svg',
-  twitterImage: 'img/devspace-logo.svg',
+  ogImage: "img/devspace-logo.svg",
+  twitterImage: "img/devspace-logo.svg",
 
   /* Colors for website */
   colors: {
-    primaryColor: '#223366',
-    secondaryColor: '#00BDFF',
+    primaryColor: "#223366",
+    secondaryColor: "#00BDFF"
   },
 
   /* Custom fonts for website */
@@ -59,39 +60,46 @@ const siteConfig = {
 
   highlight: {
     // Highlight.js theme to use for syntax highlighting in code blocks.
-    theme: 'atom-one-dark',
+    theme: "atom-one-dark"
   },
 
   // Add custom scripts here that would be placed in <script> tags.
   scripts: [
-    'https://buttons.github.io/buttons.js',
-    'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
-    '/js/code-block-buttons.js',
-    '/js/code-block-line-numbers.js',
-    '/js/responsive-menu.js',
-    '/js/tag-manager.js',
-    '/js/onpage-nav.js',
+    "https://buttons.github.io/buttons.js",
+    "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",
+    "/js/code-block-buttons.js",
+    "/js/code-block-line-numbers.js",
+    "/js/responsive-menu.js",
+    "/js/tag-manager.js",
+    "/js/onpage-nav.js"
   ],
 
   stylesheets: [
     "https://fonts.googleapis.com/css?family=Play|Raleway:400,500,600"
   ],
 
   // On page navigation for the current documentation page.
-  onPageNav: 'separate',
+  onPageNav: "separate",
   // No .html extensions for paths.
   cleanUrl: true,
-  disableHeaderTitle:true,
+  disableHeaderTitle: true,
   disableTitleTagline: true,
   // Show documentation's last contributor's name.
   // enableUpdateBy: true,
 
   // Show documentation's last update time.
   enableUpdateTime: true,
 
-  customDocsPath: 'pages',
+  customDocsPath: "pages",
   docsSideNavCollapsible: true,
-  editUrl: 'https://github.com/devspace-cloud/devspace/edit/master/docs/pages/',
+  editUrl: "https://github.com/devspace-cloud/devspace/edit/master/docs/pages/",
+
+  algolia: {
+    apiKey: "4339e8c4d6313d53209b996a35e7c0d5",
+    indexName: "devspace",
+    placeholder: "Search...",
+    algoliaOptions: {}
+  }
 };
 
 module.exports = siteConfig;