added 'Contribution / Development section

contributing-branches.rst

@@ -0,0 +1,28 @@
+Branches
+********
+
+The Zammad main repo @ https://github.com/zammad/zammad has several branches
+
+Master
+======
+
+* current unreleased development state of current minor release
+* stable
+
+Develop
+=======
+
+* current unreleased development state of next major release
+* unstable
+
+Stable
+======
+
+* current stable release with bugfixes e. g. 1.0.1, 1.0.2, 1.1.0 if available 
+
+Stable-X.x
+==========
+
+* There will be several more Stable branches because we'll support the last 3 major versions of Zammad
+* In the moment this would be 1.0.x, 1.1.x, and 1.2.x
+

appendix-install-source-debian.rst → contributing-dev-install.rst

@@ -1,18 +1,21 @@
-Install from source for developers (Debian 7,8 / Ubuntu 16.04)
-**************************************************************
+Developer installation
+**********************
+
+Install from source (Debian 7,8 / Ubuntu 16.04)
+===============================================
 
 With Nginx & MySQL
-==================
+------------------
 
 Prerequisites
--------------
++++++++++++++
 
 ::
 
  apt-get install curl git-core patch build-essential bison zlib1g-dev libssl-dev libxml2-dev libxml2-dev sqlite3 libsqlite3-dev autotools-dev libxslt1-dev libyaml-0-2 autoconf automake libreadline6-dev libyaml-dev libtool libgmp-dev libgdbm-dev libncurses5-dev pkg-config libffi-dev libmysqlclient-dev mysql-server nginx gawk
 
 Add User
---------
+++++++++
 
 ::
 
@@ -21,14 +24,14 @@ Add User
 
 
 Create MySQL User zammad (for Debian: upgrade MySQL to v5.6+ before, see: http://dev.mysql.com/downloads/repo/apt/)
--------------------------------------------------------------------------------------------------------------------
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 ::
 
  mysql --defaults-extra-file=/etc/mysql/debian.cnf -e "CREATE USER 'zammad'@'localhost' IDENTIFIED BY 'Your_Pass_Word!'; GRANT ALL PRIVILEGES ON zammad_prod.* TO 'zammad'@'localhost'; FLUSH PRIVILEGES;"
 
 Get Zammad
-----------
+++++++++++
 
 ::
 
@@ -39,9 +42,7 @@ Get Zammad
  exit
 
 Create Nginx Config
--------------------
-
-
++++++++++++++++++++
 
 ::
 
@@ -58,7 +59,7 @@ Create Nginx Config
  ln -s /etc/nginx/sites-available/zammad.conf /etc/nginx/sites-enabled/zammad.conf
 
 Install Environnment
---------------------
+++++++++++++++++++++
 
 ::
 
@@ -73,7 +74,7 @@ Install Environnment
  gem install bundler
 
 Install Zammad
---------------
+++++++++++++++
 
 ::
 
@@ -94,7 +95,7 @@ Install Zammad
  rake assets:precompile
 
 Start Zammad
-------------
+++++++++++++
 
 ::
 
@@ -103,14 +104,79 @@ Start Zammad
  script/scheduler.rb start &>> log/zammad.log &
 
 Restart nginx as root
----------------------
++++++++++++++++++++++
 
 ::
 
  exit
  systemctl restart nginx
 
 Go to http://localhost and you'll see:
--------------------------------------
+++++++++++++++++++++++++++++++++++++++
 
 * "Welcome to Zammad!", there you need to create your admin user and you need to invite other agents.
+
+
+Install from source (Mac OS 10.8)
+=================================
+
+Prerequisites
+-------------
+
+* Install Xcode from the App Store, open it -> Xcode menu > Preferences > Downloads -> install command line tools
+
+::
+
+ curl -L https://get.rvm.io | bash -s stable --ruby
+ source ~/.rvm/scripts/rvm
+ start new shell -> ruby -v
+
+Get Zammad
+----------
+
+::
+
+ test -d ~/zammad/ || mkdir ~/zammad
+ cd ~/zammad/
+ curl -L -O https://ftp.zammad.com/zammad-latest.tar.bz2 | tar -xj
+
+
+Install Zammad
+--------------
+
+::
+
+ cd zammad-latest
+ bundle install
+ sudo ln -s /usr/local/mysql/lib/libmysqlclient.18.dylib /usr/lib/libmysqlclient.18.dylib # if needed!
+ rake db:create
+ rake db:migrate
+ rake db:seed
+
+
+Database connect
+----------------
+
+::
+
+ cd zammad-latest
+ cp config/database.yml.dist config/database.yml
+ rake db:create
+ rake db:migrate
+ rake db:seed
+
+Start Zammad
+------------
+
+::
+
+ puma -p 3000 # application web server
+ script/websocket-server.rb start # non blocking websocket server
+ script/scheduler.rb start # generate overviews on demand, just send changed data to browser
+
+
+Visit Zammad in your browser page
+---------------------------------
+
+* http://localhost:3000/#getting_started
+

contributing-packages.rst

@@ -0,0 +1,8 @@
+Packages
+********
+
+* Zammad packages are build on packager.io.
+* You can find all Zammad packages @ https://packager.io/gh/zammad/zammad
+* Builds of new packages are triggered with everey push to our GitHub repo
+* If you fork the Zammad repo you can use packager.io to get builds for your fork
+* Just change the file ".pkgr.yml" to fit your needs

contributing-start.rst

@@ -0,0 +1,31 @@
+Start
+*****
+
+We would be glad if you contribute to Zammad. You can do this on several places. Contributions are mainly done by forking one of our repos on GitHub and creating a pull request from your changes.
+
+All repos can be found @ https://github.com/zammad
+
+Source Code
+===========
+
+The Zammad sourcecode can be found on GitHub @ https://github.com/zammad/zammad
+
+
+Documentation
+=============
+
+Do you want to contribute to the Zammad documentation?
+
+Open a new GitHub pull request @ https://github.com/zammad/zammad-documentation with your changes.
+
+ReStructuredText markup
+-----------------------
+
+If you like to edit the docs use the ReStructuredText markup language. Infos about this markup language can be found at:
+
+- http://www.sphinx-doc.org/en/stable/rest.html
+- http://docs.readthedocs.io/en/latest/_themes/sphinx_rtd_theme/demo_docs/source/demo.html
+
+Thanks! ❤️ ❤️ ❤️
+
+  Zammad Team

index.rst

@@ -10,6 +10,7 @@ The documentation for Zammad is organized into a couple of sections:
 * :ref:`migration-docs`
 * :ref:`general-docs`
 * :ref:`channels-docs`
+* :ref:`contributing-docs`
 * :ref:`rest-api-docs`
 * :ref:`appendix-docs`
 
@@ -91,6 +92,17 @@ The documentation for Zammad is organized into a couple of sections:
    channel-facebook
    channel-fetchmail
 
+.. _contributing-docs:
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+   :caption: Contributing / Development
+
+   contributing-start
+   contributing-branches
+   contributing-packages
+   contributing-dev-install
 
 .. _rest-api-docs:
 
@@ -106,15 +118,3 @@ The documentation for Zammad is organized into a couple of sections:
    api-ticket
    api-ticket-state
    api-ticket-priority
-
-
-.. _appendix-docs:
-
-.. toctree::
-   :maxdepth: 2
-   :glob:
-   :caption: Appendix
-
-   appendix-install-source-debian
-   appendix-install-source-mac
-