Skip to content

Commit f5be86c

Browse files
committed
Restored search in docs, started Community docs, re #4.
1 parent 12d4e13 commit f5be86c

7 files changed

Lines changed: 76 additions & 8 deletions

File tree

docs/api/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
:title: API
1+
:title: api
22
:description: -- todo: change me
3-
:keywords: deis, documentation, tutorial, contributing, faq
3+
:keywords: deis, documentation, api
44

55
.. _api:
66

docs/contributing/community.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
:title: Community
2+
:description: -- todo: change me
3+
:keywords: deis, documentation, community, bdfl, code, conduct, code of conduct
4+
5+
.. _community:
6+
7+
Community
8+
=========
9+
10+
11+
Conduct
12+
=======
13+
14+
The deis community welcomes and encourages participation by everyone.
15+
16+
No matter how you identify yourself or how others perceive you: we welcome
17+
you. We welcome contributions from everyone as long as they interact
18+
constructively with our community.
19+
20+
While much of the work for our project is technical in nature, we value and
21+
encourage contributions from those with expertise in other areas, and welcome
22+
them into our community.

docs/contributing/developer.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
:title: Developer Setup
2+
:description: -- todo: change me
3+
:keywords: deis, documentation, contributing, developer, setup
4+
5+
.. _developer:
6+
7+
Developer Setup
8+
===============
9+

docs/contributing/index.rst

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,42 @@
77
Contributing
88
============
99

10-
**Coming soon...**
10+
How Can I Help?
11+
---------------
12+
13+
File Bugs & Enhancements
14+
~~~~~~~~~~~~~~~~~~~~~~~~
15+
Find a bug? Want to see a new feature? Have a request
16+
for the maintainers? Open a GitHub issue and we’ll get the conversation
17+
started.
18+
19+
Write Documentation
20+
~~~~~~~~~~~~~~~~~~~
21+
We are always looking to improve and expand our
22+
documentation. Most docs reside in the main repository under the docs/
23+
directory. Simply fork the project, update docs and send us a pull request.
24+
25+
Enhance Chef Integration
26+
~~~~~~~~~~~~~~~~~~~~~~~~
27+
We want Chef users to feel at home using Deis. Got an
28+
idea for improving our Chef integration? Have some thoughts on making the
29+
deis-cookbook more reusable? Open a GitHub issue and let us know!
30+
31+
Add New Cloud Providers
32+
~~~~~~~~~~~~~~~~~~~~~~~
33+
Want to see Deis extended to a new cloud provider? Go
34+
for it! Adding new providers is easy. Just follow the EC2 example and make
35+
sure you provide test coverage in your pull request.
36+
37+
Improve Deis Core
38+
~~~~~~~~~~~~~~~~~
39+
Deis core is a Django/Celery application with a Python CLI.
40+
We are always looking for help improving the core framework, tooling and test
41+
coverage. Interested in contributing to Deis core? Let’s chat in IRC.
42+
43+
.. toctree::
44+
:maxdepth: 1
45+
46+
developer
47+
community
48+

docs/index.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
:description: An overview of the Deis documentation
33
:keywords: api, commandline, command-line, contributing, faq, terms, tutorial, deis, docker, heroku
44

5-
Documentation
6-
=============
7-
8-
.. image:: https://s3-us-west-2.amazonaws.com/deis-images/deis-graphic.png
5+
Welcome
6+
=======
97

8+
.. image:: _static/img/deis-graphic.png
109

1110
``deis`` is an open source PaaS that makes it easy to deploy
1211
:ref:`container`\s and :ref:`node`\s used to host applications,

docs/theme/deis/layout.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
</div>
7373

7474
<div class="span3 docs-sidebar">
75-
75+
{%- include "searchbox.html" %}
7676
{{ toctree(collapse=False, maxdepth=3) }}
7777
</div>
7878

web/static/img/deis-graphic.png

28.4 KB
Loading

0 commit comments

Comments
 (0)