Merge pull request #46 from cloudflare/docs-engine-content

Docs engine content updates

Author: adamschwartz

products/docs-engine/src/content/contributors-guide.md renamed to products/docs-engine/src/content/contributing/content-framework.md

@@ -1,8 +1,8 @@
 ---
-order: 3
+order: 1
 ---
 
-# Contributor’s guide
+# Content framework
 
 This page provides an overview of how best to contribute to Cloudflare’s documentation. This is a living document and will be updated as recommendations change.
 

products/docs-engine/src/content/contributing/development-setup.md

@@ -0,0 +1,66 @@
+---
+order: 0
+---
+
+# Development setup
+
+<Aside>
+
+__Note for Cloudflare employees__
+
+Follow the [Migrate a Product](/how-to-guides/migrate-a-product) how-to guide instead.
+
+The content below is here for completeness, and describes the theoretical way to set up the Docs Engine with _any_ project. At Cloudflare we’ve decided to follow the monorepo approach for our docs content, putting all of our docs content inside [@cloudflare/cloudflare-docs](http://github.com/cloudflare/cloudflare-docs) rather than a per-product repo. As such, the how-to guide listed above includes the specific instructions for setting up a development environment with our monorepo.
+
+</Aside>
+
+The basic steps for setting up a development are as follows.
+
+1. Clone [@cloudflare/cloudflare-docs-engine](http://github.com/cloudflare/cloudflare-docs-engine) and your repo (`@example-username/my-docs-content` below):
+
+  ```sh
+  ~/ $ git clone [email protected]:cloudflare/cloudflare-docs-engine.git
+  ~/ $ git clone [email protected]:example-username/my-docs-content.git
+  ```
+
+2. `cd` into `cloudflare-docs-engine`, run `npm link`, then return to the parent directory.
+
+  ```sh
+  ~/ $ cd cloudflare-docs-engine
+  ~/cloudflare-docs-engine $ npm link
+  ~/cloudflare-docs-engine $ cd ..
+  ```
+
+3. `cd` into `my-docs-content`:
+
+  ```sh
+  ~/ $ cd my-docs-content
+  ```
+
+5. Inside your project’s folder, link the engine:
+
+  ```sh
+  ~/my-docs-content $ npm link cloudfare-docs-engine
+  ```
+
+6. Run the engine’s [`bootstrap` command](https://github.com/cloudflare/cloudflare-docs-engine/blob/765bc30127b0e80b570aade7044036925928c3ea/bin/commands.sh#L19-L39):
+
+  ```sh
+  ~/my-docs-content $ npm run bootstrap
+  ```
+
+7. Run the local development server:
+
+  ```sh
+  ~/my-docs-content $ npm run develop
+  ```
+
+8. Open up `localhost:8000` in your browser to see your docs site.
+
+At this point, you can make changes to the Markdown files inside the contect directory (e.g. `my-docs-content/src/content`) to improve your docs site.
+
+<Aside>
+
+__Note:__ Unfortunately, for now you’ll need to stop and restart `npm run develop` every time you make changes. This is something we’re urgently looking to fix and can be tracked [in this Github issue](https://github.com/cloudflare/cloudflare-docs-engine/issues/279), which also includes a workaround which may help in the interim.
+
+</Aside>

products/docs-engine/src/content/contributing/index.md

@@ -0,0 +1,8 @@
+---
+type: overview
+order: 3
+---
+
+# Contributing
+
+<DirectoryListing path="/contributing"/>

products/docs-engine/src/content/contributing/to-docs-engine.md

@@ -0,0 +1,22 @@
+---
+title: To Docs Engine
+order: 2
+---
+
+# Contribute to the Docs Engine
+
+## Background
+
+The Cloudflare Docs Engine is based on [Gatsby](https://www.gatsbyjs.com), and enables developers to quickly build out docs sites by allowing them to focus on the Markdown content.
+
+Authors can leverage the power of MDX by building custom compontents or utilize the powerful [built-in components](/reference/markdown).
+
+## Contributing
+
+To contribute, just make a pull request on [@cloudflare/cloudflare-docs-engine](https://github.com/cloudflare/cloudflare-docs-engine).
+
+There are a number of [open issues](https://github.com/cloudflare/cloudflare-docs-engine/issues) we would love the community’s help with solving.
+
+## More to come
+
+There are a number of meaty issues we’re really excited to tackle with the community. Stay tuned for more information about those here.

products/docs-engine/src/content/example-pages/index.md

@@ -2,7 +2,7 @@
 
 Code blocks inside [Docs Engine Markdown](/reference/markdown) offer a variety of custom presentation mechanisms. This page contains practical examples for inspiration.
 
-Learn more about [using code blocks inside Markdown](/reference/markdown#codeblocks).
+Learn more about [using code blocks inside Markdown](/reference/markdown#code-blocks).
 
 --------------------------------
 

products/docs-engine/src/content/markdown/code-block-examples.md renamed to products/docs-engine/src/content/examples/code-block-examples.md

@@ -0,0 +1,8 @@
+---
+type: overview
+order: 5
+---
+
+# Examples
+
+<DirectoryListing path="/examples"/>

products/docs-engine/src/content/examples/index.md

@@ -0,0 +1,9 @@
+---
+order: 3
+---
+
+# Example pages
+
+Use these as a starting point for writing consistent docs.
+
+<DirectoryListing path="/examples/example-pages"/>