Skip to content

Commit e7ab6d6

Browse files
committed
Started dev setup documentation, re #1.
1 parent 8743735 commit e7ab6d6

1 file changed

Lines changed: 80 additions & 2 deletions

File tree

docs/contributing/devsetup.rst

Lines changed: 80 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,87 @@
11
:title: Developer Setup
2-
:description: -- todo: change me
3-
:keywords: deis, documentation, contributing, developer, setup
2+
:description: Setting up your workstation for Deis development
3+
:keywords: deis, documentation, contributing, developer, setup, chef, knife
44

55
.. _devsetup:
66

77
Developer Setup
88
===============
99

10+
Thank you for contributing to Deis! We have tried to make it simple
11+
to work on Deis, but as an open PaaS there are necessarily several
12+
moving pieces and some setup required. We welcome any suggestions for
13+
automating or simplifying this process.
14+
15+
16+
Prerequisites
17+
-------------
18+
19+
We assume you have a modern UNIX-like environment, such as Linux or
20+
Mac OS X. Many of the tools listed below will probably be present
21+
already, but install those that are not:
22+
23+
- git
24+
- GNU Make
25+
- `Python`_ 2.7.x
26+
- `Ruby`_ 1.9 (for knife.rb)
27+
- `Amazon EC2 API Tools`_
28+
29+
To contribute code back to Deis, you must also have a GitHub.com account
30+
in order to create a pull request.
31+
32+
33+
Fetch Git Repositories
34+
----------------------
35+
36+
.. code-block:: console
37+
38+
$ git clone -q https://github.com/opdemand/deis.git
39+
$ git clone -q https://github.com/opdemand/deis-cookbook.git
40+
$ cd deis
41+
42+
43+
Make a Virtualenv
44+
-----------------
45+
46+
To keep Deis` requirements separate from other development you may do,
47+
it's preferable to create a **virtual environment** for python.
48+
49+
.. code-block:: console
50+
51+
$ virtualenv venv --prompt='(deis)'
52+
New python executable in venv/bin/python
53+
Installing Setuptools.................................done.
54+
Installing Pip........................................done.
55+
$ source venv/bin/activate
56+
(deis)$ pip install -r dev_requirements.txt --use-mirrors
57+
Downloading/unpacking azure>=0.7.0 (from -r dev_requirements.txt (line 2))
58+
Downloading azure-0.7.0.zip (76kB): 76kB downloaded
59+
Running setup.py egg_info for package azure
60+
Downloading/unpacking boto>=2.9.8 (from -r dev_requirements.txt (line 3))
61+
...
62+
Successfully installed azure boto ...
63+
Cleaning up...
64+
(deis)$
65+
66+
Make sure you install the requirements in the dev_requirements.txt file,
67+
which contains several additions over the runtime requirements.txt file.
68+
Please see the `virtualenv documentation`_ for more details on python virtual
69+
environments.
70+
71+
72+
Install knife.rb
73+
----------------
74+
75+
** Coming soon... ***
76+
77+
78+
Set Up a Chef Account
79+
---------------------
80+
81+
** Coming soon... ***
82+
83+
84+
.. _`virtualenv documentation`: http://www.virtualenv.org/en/latest/
85+
.. _`Python`: http://python.org/
86+
.. _`Ruby`: http://ruby-lang.org/
87+
.. _`Amazon EC2 API Tools`: http://aws.amazon.com/developertools/Amazon-EC2/351

0 commit comments

Comments
 (0)