Skip to content

Commit

Permalink
Index docs page update.
Browse files Browse the repository at this point in the history
  • Loading branch information
idlesign committed Jul 3, 2017
1 parent a20b7bf commit 681f071
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,22 @@ Description

*Configure uWSGI from your Python code*

Here will be an introductory description.
If you think you known uWSGI you're probably wrong. It is always more than you think it is.
There are so many subsystems and options_ it is difficult to even try to wrap your mind around.

.. _options: http://uwsgi-docs.readthedocs.io/en/latest/Options.html

**uwsgiconf** allowing to define uWSGI configurations in Python tries to improve things the following ways:

* It structures options for various subsystems using classes and methods;
* It uses docstrings and sane naming to facilitate navigation;
* It ships some useful presets to reduce boilerplate code;

*Consider using IDE with autocompletion and docstings support to be more productive with uwsgiconf.*

By that time you already know that **uwsgiconf** is just another configuration method. Why_?

.. _Why: http://uwsgi-docs.readthedocs.io/en/latest/FAQ.html#why-do-you-support-multiple-methods-of-configuration


Requirements
Expand Down Expand Up @@ -41,3 +55,17 @@ API
grp_networking
grp_workers
grp_plugin_python


Get involved into uwsgiconf
---------------------------

**Submit issues.** If you spotted something weird in application behavior or want to propose a feature you can do that
at https://github.com/idlesign/uwsgiconf/issues

**Write code.** If you are eager to participate in application development, fork it
at https://github.com/idlesign/uwsgiconf, write your code, whether it should be a bugfix or a feature implementation,
and make a pull request right from the forked project page.

**Spread the word.** If you have some tips and tricks or any other words in mind that you think might
be of interest for the others — publish it.

0 comments on commit 681f071

Please sign in to comment.