Skip to content

Commit 639e80c

Browse files
author
Gabriel Monroy
committed
pushing new structure for sphinx nav
1 parent e0db967 commit 639e80c

18 files changed

Lines changed: 173 additions & 99 deletions

‎client/deis.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
Usage: deis <command> [--formation <formation>] [<args>...]
66
7-
::
7+
Auth commands::
88
99
register register a new user with a controller
1010
login login to a controller

docs/commandline/index.rst renamed to docs/client/cheatsheet.rst

File renamed without changes.

‎docs/client/converge.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
========
2+
converge
3+
========
4+
5+
.. automethod:: client.deis.DeisClient.formations_converge

‎docs/client/index.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:title: client
2+
:description: -- todo: change me
3+
:keywords: deis, documentation, api
4+
5+
.. _client:
6+
7+
CLI Reference
8+
=============
9+
10+
:Release: |version|
11+
:Date: |today|
12+
13+
.. toctree::
14+
:maxdepth: 1
15+
16+
cheatsheet
17+
login
18+
converge

‎docs/client/login.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
=====
2+
login
3+
=====
4+
5+
.. automethod:: client.deis.DeisClient.auth_login

‎docs/contributing/community.rst‎

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -21,48 +21,8 @@ ends up in the official GitHub repository for Deis. Deis depends on the
2121
contributions of the community; the maintainers will not ignore pull
2222
requests or issues.
2323

24-
Conduct
25-
=======
2624

27-
The deis community welcomes and encourages participation by **everyone**.
28-
29-
No matter how you identify yourself or how others perceive you: we welcome
30-
you. We welcome contributions from everyone as long as they interact
31-
constructively with our community.
32-
33-
The deis developer community continues to grow, and it is inevitable that
34-
disagreements and conflict will arise. We ask that participants conduct
35-
themselves according to these principles:
36-
37-
- **Be welcoming, friendly, and patient.**
38-
39-
- **Be considerate.**
40-
41-
Your work will be used by other people, and you in turn will depend on
42-
the work of others. Any decision you take will affect users and
43-
colleagues, and you should take those consequences into account when
44-
making decisions. Remember that we're a world-wide community, so you
45-
might not be communicating in someone else's primary language.
46-
47-
- **Be respectful.**
48-
49-
Not all of us will agree all the time, but disagreement is no excuse
50-
for poor behavior and bad manners. We might all experience some
51-
frustration now and then, but we cannot allow that frustration to turn
52-
into a personal attack. It’s important to remember that a community
53-
where people feel uncomfortable or threatened is not a productive one.
54-
55-
- **Be careful in the words that you choose.**
56-
57-
Be kind to others. Do not insult or put down other participants.
58-
Behave professionally. Remember that harassment and sexist, racist, or
59-
exclusionary jokes are never appropriate for the community.
60-
61-
(Thanks to the `Debian`_ and `Django`_ communities for their text and
62-
their inspiration.)
6325

6426
.. _`on Github`: https://github.com/opdemand/deis
6527
.. _`OpDemand`: http://www.opdemand.com/
66-
.. _`Debian`: http://www.debian.org/intro/diversity
67-
.. _`Django`: https://www.djangoproject.com/conduct/
6828

‎docs/contributing/conduct.rst‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
:title: Conduct
2+
:description: -- todo: change me
3+
:keywords: deis, documentation, community, bdfl, code, conduct, code of conduct
4+
5+
.. _conduct:
6+
7+
Conduct
8+
=======
9+
10+
The deis community welcomes and encourages participation by **everyone**.
11+
12+
No matter how you identify yourself or how others perceive you: we welcome
13+
you. We welcome contributions from everyone as long as they interact
14+
constructively with our community.
15+
16+
The deis developer community continues to grow, and it is inevitable that
17+
disagreements and conflict will arise. We ask that participants conduct
18+
themselves according to these principles:
19+
20+
- **Be welcoming, friendly, and patient.**
21+
22+
- **Be considerate.**
23+
24+
Your work will be used by other people, and you in turn will depend on
25+
the work of others. Any decision you take will affect users and
26+
colleagues, and you should take those consequences into account when
27+
making decisions. Remember that we're a world-wide community, so you
28+
might not be communicating in someone else's primary language.
29+
30+
- **Be respectful.**
31+
32+
Not all of us will agree all the time, but disagreement is no excuse
33+
for poor behavior and bad manners. We might all experience some
34+
frustration now and then, but we cannot allow that frustration to turn
35+
into a personal attack. It’s important to remember that a community
36+
where people feel uncomfortable or threatened is not a productive one.
37+
38+
- **Be careful in the words that you choose.**
39+
40+
Be kind to others. Do not insult or put down other participants.
41+
Behave professionally. Remember that harassment and sexist, racist, or
42+
exclusionary jokes are never appropriate for the community.
43+
44+
(Thanks to the `Debian`_ and `Django`_ communities for their text and
45+
their inspiration.)
46+
47+
.. _`Debian`: http://www.debian.org/intro/diversity
48+
.. _`Django`: https://www.djangoproject.com/conduct/

docs/contributing/developer.rst renamed to docs/contributing/devsetup.rst

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,9 @@
22
:description: -- todo: change me
33
:keywords: deis, documentation, contributing, developer, setup
44

5-
.. _developer:
5+
.. _devsetup:
66

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

1010
**Coming soon...**
11-
12-
Coding Standards
13-
================
14-
15-
**Coming soon...**

‎docs/contributing/index.rst‎

Lines changed: 6 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2,52 +2,18 @@
22
:description: TOOD
33
:keywords: todo
44

5-
.. _contributing:
6-
75
Contributing
86
============
97

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

4811
.. toctree::
4912
:maxdepth: 1
5013

51-
developer
14+
overview
15+
devsetup
16+
standards
5217
community
18+
conduct
5319

‎docs/contributing/overview.rst‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
:title: Contributing Overview
2+
:description: TOOD
3+
:keywords: todo
4+
5+
.. _contributingoverview:
6+
7+
Overview
8+
========
9+
10+
File Bugs & Enhancements
11+
------------------------
12+
Find a bug? Want to see a new feature? Have a request
13+
for the maintainers? Open a `GitHub issue`_ and we’ll get the conversation
14+
started.
15+
16+
Write Documentation
17+
-------------------
18+
We are always looking to improve and expand our
19+
documentation. Most docs reside in the main repository under the `docs/`_
20+
directory. Simply fork the project, update docs and send us a pull request.
21+
22+
Enhance Chef Integration
23+
------------------------
24+
We want Chef users to feel at home using Deis. Got an
25+
idea for improving our Chef integration? Have some thoughts on making the
26+
`deis-cookbook`_ more reusable? Open a `GitHub issue`_ and let us know!
27+
28+
Add New Cloud Providers
29+
-----------------------
30+
Want to see Deis extended to a new cloud provider? Go
31+
for it! Adding new providers is easy. Just follow the `EC2 example`_ and make
32+
sure you provide test coverage in your pull request.
33+
34+
Improve Deis Core
35+
-----------------
36+
Deis core is a Django/Celery application with a Python CLI.
37+
We are always looking for help improving the core framework, tooling and test
38+
coverage. Interested in contributing to Deis core? Let’s chat in IRC.
39+
40+
.. _`Github issue`: https://github.com/opdemand/deis/issues/new
41+
.. _`docs/`: https://github.com/opdemand/deis/tree/master/docs
42+
.. _`deis-cookbook`: https://github.com/opdemand/deis-cookbook
43+
.. _`EC2 Example`: https://github.com/opdemand/deis/blob/master/celerytasks/ec2.py

0 commit comments

Comments
 (0)