Restored search in docs, started Community docs, re #4.

deis · Aug 2, 2013 · f5be86c · f5be86c
1 parent 12d4e13
commit f5be86c
Show file tree

Hide file tree

Showing 7 changed files with 76 additions and 8 deletions.
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -1,6 +1,6 @@
-:title: API
+:title: api
 :description: -- todo: change me
-:keywords: deis, documentation, tutorial, contributing, faq
+:keywords: deis, documentation, api
 
 .. _api:
 

diff --git a/docs/contributing/community.rst b/docs/contributing/community.rst
@@ -0,0 +1,22 @@
+:title: Community
+:description: -- todo: change me
+:keywords: deis, documentation, community, bdfl, code, conduct, code of conduct
+
+.. _community:
+
+Community
+=========
+
+
+Conduct
+=======
+
+The deis community welcomes and encourages participation by everyone.
+
+No matter how you identify yourself or how others perceive you: we welcome
+you. We welcome contributions from everyone as long as they interact
+constructively with our community.
+
+While much of the work for our project is technical in nature, we value and
+encourage contributions from those with expertise in other areas, and welcome
+them into our community.
diff --git a/docs/contributing/developer.rst b/docs/contributing/developer.rst
@@ -0,0 +1,9 @@
+:title: Developer Setup
+:description: -- todo: change me
+:keywords: deis, documentation, contributing, developer, setup
+
+.. _developer:
+
+Developer Setup
+===============
+
diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst
@@ -7,4 +7,42 @@
 Contributing
 ============
 
-**Coming soon...**
+How Can I Help?
+---------------
+
+File Bugs & Enhancements
+~~~~~~~~~~~~~~~~~~~~~~~~
+Find a bug? Want to see a new feature? Have a request
+for the maintainers? Open a GitHub issue and we’ll get the conversation
+started.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+We are always looking to improve and expand our
+documentation. Most docs reside in the main repository under the docs/
+directory. Simply fork the project, update docs and send us a pull request.
+
+Enhance Chef Integration
+~~~~~~~~~~~~~~~~~~~~~~~~
+We want Chef users to feel at home using Deis. Got an
+idea for improving our Chef integration? Have some thoughts on making the
+deis-cookbook more reusable? Open a GitHub issue and let us know!
+
+Add New Cloud Providers
+~~~~~~~~~~~~~~~~~~~~~~~
+Want to see Deis extended to a new cloud provider? Go
+for it! Adding new providers is easy. Just follow the EC2 example and make
+sure you provide test coverage in your pull request.
+
+Improve Deis Core
+~~~~~~~~~~~~~~~~~
+Deis core is a Django/Celery application with a Python CLI.
+We are always looking for help improving the core framework, tooling and test
+coverage. Interested in contributing to Deis core? Let’s chat in IRC.
+
+.. toctree::
+    :maxdepth: 1
+
+    developer
+    community
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -2,11 +2,10 @@
 :description: An overview of the Deis documentation
 :keywords: api, commandline, command-line, contributing, faq, terms, tutorial, deis, docker, heroku
 
-Documentation
-=============
-
-.. image:: https://s3-us-west-2.amazonaws.com/deis-images/deis-graphic.png
+Welcome
+=======
 
+.. image:: _static/img/deis-graphic.png
 
 ``deis`` is an open source PaaS that makes it easy to deploy
 :ref:`container`\s and  :ref:`node`\s used to host applications,

diff --git a/docs/theme/deis/layout.html b/docs/theme/deis/layout.html
@@ -72,7 +72,7 @@
             </div>
 
             <div class="span3 docs-sidebar">
-
+              {%- include "searchbox.html" %}
               {{ toctree(collapse=False, maxdepth=3) }}
             </div>
 

diff --git a/web/static/img/deis-graphic.png b/web/static/img/deis-graphic.png