docs: structure for v0.1 docs site

Signed-off-by: Jared Watts <jbw976@gmail.com>
arturrez · Dec 4, 2018 · f527919 · f527919
1 parent a83afa5
commit f527919
Show file tree

Hide file tree

Showing 32 changed files with 146 additions and 13 deletions.
diff --git a/docs/design/custom-secret-definitions.md → design/custom-secret-definitions.md b/docs/design/custom-secret-definitions.md → design/custom-secret-definitions.md
diff --git a/docs-old/README.md b/docs-old/README.md
@@ -0,0 +1,5 @@
+# User Guides
+
+* [Wordpress Quickstart](wordpress/quickstart.md)
+* [Wordpress Workload Demo](workload/demo.md)
+* [Troubleshooting](troubleshooting.md)
diff --git a/docs/architecture.md → docs-old/architecture.md b/docs/architecture.md → docs-old/architecture.md
diff --git a/docs-old/concepts.md b/docs-old/concepts.md
@@ -0,0 +1,6 @@
+---
+title: Concepts
+toc: true
+weight: 300
+---
+# Concepts
diff --git a/docs/contribute.md → docs-old/contribute.md b/docs/contribute.md → docs-old/contribute.md
diff --git a/docs-old/deploy.md b/docs-old/deploy.md
@@ -0,0 +1,11 @@
+---
+title: Deploy
+toc: true
+weight: 130
+indent: true
+---
+# Deploy
+
+Thank you for your time and effort to help us improve Crossplane! Here are a few steps to get started. If you have any questions, don’t hesitate to reach out to us on our [Slack](https://crossplaneio.slack.com) dev channel.
+
+## Improving the docs
diff --git a/docs/design.md → docs-old/design.md b/docs/design.md → docs-old/design.md
diff --git a/docs-old/faqs.md b/docs-old/faqs.md
@@ -0,0 +1,6 @@
+---
+title: FAQS
+toc: true
+weight: 400
+---
+# FAQS
diff --git a/docs/guides.md → docs-old/guides.md b/docs/guides.md → docs-old/guides.md
diff --git a/docs/prerequisites.md → docs-old/prerequisites.md b/docs/prerequisites.md → docs-old/prerequisites.md
diff --git a/docs/reference.md → docs-old/reference.md b/docs/reference.md → docs-old/reference.md
diff --git a/docs/releases.md → docs-old/releases.md b/docs/releases.md → docs-old/releases.md
diff --git a/docs/troubleshooting.md → docs-old/troubleshooting.md b/docs/troubleshooting.md → docs-old/troubleshooting.md
diff --git a/docs/wordpress/quickstart-aws.md → docs-old/wordpress/quickstart-aws.md b/docs/wordpress/quickstart-aws.md → docs-old/wordpress/quickstart-aws.md
diff --git a/docs/wordpress/quickstart-azure.md → docs-old/wordpress/quickstart-azure.md b/docs/wordpress/quickstart-azure.md → docs-old/wordpress/quickstart-azure.md
diff --git a/docs/wordpress/quickstart-gcp.md → docs-old/wordpress/quickstart-gcp.md b/docs/wordpress/quickstart-gcp.md → docs-old/wordpress/quickstart-gcp.md
diff --git a/docs/wordpress/quickstart.md → docs-old/wordpress/quickstart.md b/docs/wordpress/quickstart.md → docs-old/wordpress/quickstart.md
diff --git a/docs/workload/aws/demo.md → docs-old/workload/aws/demo.md b/docs/workload/aws/demo.md → docs-old/workload/aws/demo.md
diff --git a/docs/workload/azure/demo.md → docs-old/workload/azure/demo.md b/docs/workload/azure/demo.md → docs-old/workload/azure/demo.md
diff --git a/docs/workload/demo.md → docs-old/workload/demo.md b/docs/workload/demo.md → docs-old/workload/demo.md
diff --git a/docs/workload/gcp/demo.md → docs-old/workload/gcp/demo.md b/docs/workload/gcp/demo.md → docs-old/workload/gcp/demo.md
diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,29 @@
-# User Guides
+---
+title: Welcome
+toc: true
+weight: 110
+---
+# Crossplane
 
-* [Wordpress Quickstart](wordpress/quickstart.md)
-* [Wordpress Workload Demo](workload/demo.md)
-* [Troubleshooting](troubleshooting.md)
+Crossplane is an open source multicloud control plane. It introduces workload and resource abstractions on-top of existing managed services that enables a high degree of workload portability across cloud providers. A single crossplane enables the provisioning and full-lifecycle management of services and infrastructure across a wide range of providers, offerings, vendors, regions, and clusters. Crossplane offers a universal API for cloud computing, a workload scheduler, and a set of smart controllers that can automate work across clouds.
+
+<h4 align="center"><img src="media/arch.png" alt="Crossplane" height="400"></h4>
+
+Crossplane presents a declarative management style API that covers a wide range of portable abstractions including databases, message queues, buckets, data pipelines, serverless, clusters, and many more coming. It’s based on the declarative resource model of the popular [Kubernetes](https://github.com/kubernetes/kubernetes) project, and applies many of the lessons learned in container orchestration to multicloud workload and resource orchestration.
+
+Crossplane supports a clean separation of concerns between developers and administrators. Developers define workloads without having to worry about implementation details, environment constraints, and policies. Administrators can define environment specifics, and policies. The separation of concern leads to a higher degree of reusability and reduces complexity.
+
+Crossplane includes a workload scheduler that can factor a number of criteria including capabilities, availability, reliability, cost, regions, and performance while deploying workloads and their resources. The scheduler works alongside specialized resource controllers to ensure policies set by administrators are honored.
+
+For a deeper dive into Crossplane, see the [architecture](https://docs.google.com/document/d/1whncqdUeU2cATGEJhHvzXWC9xdK29Er45NJeoemxebo/edit?usp=sharing) document.
+
+* [Quick Start Guide](quick-start.md)
+* [Getting Started](getting-started.md)
+  * [Installing Crossplane Software](install-crossplane.md)
+  * [Adding Your Cloud Providers](cloud-providers.md)
+  * [Deploying Workloads](deploy.md)
+  * [Running Resources](running-resources.md)
+  * [Troubleshooting](troubleshoot.md)
+* [Concepts](concepts.md)
+* [FAQs](faqs.md)
+* [Contributing](contributing.md)
diff --git a/docs/cloud-providers.md b/docs/cloud-providers.md
@@ -0,0 +1,17 @@
+---
+title: Adding Your Cloud Providers
+toc: true
+weight: 330
+indent: true
+---
+# Adding Your Cloud Providers
+
+* [Google Cloud Platform (GCP)](#google-cloud-platform-gcp)
+* [Microsoft Azure](#microsoft-azure)
+* [Amazon Web Services (AWS)](#amazon-web-services-aws)
+
+## Google Cloud Platform (GCP)
+
+## Microsoft Azure
+
+## Amazon Web Services (AWS)
diff --git a/docs/concepts.md b/docs/concepts.md
@@ -1,6 +1,18 @@
 ---
 title: Concepts
 toc: true
-weight: 300
+weight: 410
 ---
-# Concepts
+# Concepts
+
+## Resources and Workloads
+
+## Control Plane
+
+## Resource Claims and Resource Classes
+
+## Dynamic and Static Provisioning
+
+## Consuming Connection Secrets
+
+## Terminology Guide
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1,6 @@
+---
+title: Contributing
+toc: true
+weight: 610
+---
+# Contributing
diff --git a/docs/deploy.md b/docs/deploy.md
@@ -1,11 +1,17 @@
 ---
 title: Deploy
 toc: true
-weight: 130
+weight: 340
 indent: true
 ---
-# Deploy
+# Deploying Workloads
 
-Thank you for your time and effort to help us improve Crossplane! Here are a few steps to get started. If you have any questions, don’t hesitate to reach out to us on our [Slack](https://crossplaneio.slack.com) dev channel.
+* [Crossplane Workload on Google Cloud Platform (GCP)](#crossplane-workload-on-google-cloud-platform-gcp)
+* [Crossplane Workload on Microsoft Azure](#crossplane-workload-on-microsoft-azure)
+* [Crossplane Workload on Amazon Web Services (AWS)](#crossplane-workload-on-amazon-web-services-aws)
 
-## Improving the docs
+## Crossplane Workload on Google Cloud Platform (GCP)
+
+## Crossplane Workload on Microsoft Azure
+
+## Crossplane Workload on Amazon Web Services (AWS)
diff --git a/docs/faqs.md b/docs/faqs.md
@@ -1,6 +1,6 @@
 ---
-title: FAQS
+title: FAQs
 toc: true
-weight: 400
+weight: 510
 ---
-# FAQS
+# Frequently Asked Questions (FAQs)
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -0,0 +1,11 @@
+---
+title: Getting Started
+toc: true
+weight: 310
+---
+# Getting Started
+
+* [Installing Crossplane Software](install-crossplane.md)
+* [Adding Your Cloud Providers](cloud-providers.md)
+* [Deploying Workloads](deploy.md)
+* [Troubleshooting](troubleshoot.md)
diff --git a/docs/install-crossplane.md b/docs/install-crossplane.md
@@ -0,0 +1,7 @@
+---
+title: Install
+toc: true
+weight: 320
+indent: true
+---
+# Installing Crossplane Software
diff --git a/docs/quick-start.md b/docs/quick-start.md
@@ -0,0 +1,8 @@
+---
+title: Quick Start Guide
+toc: true
+weight: 210
+---
+# Quick Start Guide
+
+## Deploying a Workload
diff --git a/docs/running-resources.md b/docs/running-resources.md
@@ -0,0 +1,7 @@
+---
+title: Running Resources
+toc: true
+weight: 350
+indent: true
+---
+# Running Resources
diff --git a/docs/troubleshoot.md b/docs/troubleshoot.md
@@ -0,0 +1,7 @@
+---
+title: Troubleshooting
+toc: true
+weight: 360
+indent: true
+---
+# Troubleshooting