Skip to content

Commit

Permalink
QA.
Browse files Browse the repository at this point in the history
  • Loading branch information
jepf committed Apr 25, 2017
1 parent bdbe52c commit d0de573
Show file tree
Hide file tree
Showing 17 changed files with 66 additions and 66 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# zammad documentation

If you want to contribute to zammad documentation, just create pull requests.
If you want to contribute to the Zammad documentation, just create pull requests.

## Documentation

Zammad hosts a searchable version of this documentation on https://docs.zammad.org
Zammad hosts a searchable version of this documentation at https://docs.zammad.org

## ReStructuredText markup

If you like to edit the docs use the ReStructuredText markup language. Infos about this markup language can be found at:
If you like to edit the docs use the ReStructuredText markup language. Information about this 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! ❤️ ❤️ ❤️
Thanks! ❤ ❤ ❤

Zammad Team

Expand Down
2 changes: 1 addition & 1 deletion contributing-install-source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Restart nginx as root
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.
* "Welcome to Zammad!", there you need to create your admin user and invite other agents.


Install from source (Mac OS 10.8)
Expand Down
2 changes: 1 addition & 1 deletion contributing-install-vagrant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ That’s it! You’re now running Zammad in a Vagrant environment.
Go to http://localhost:8080 and you'll see:
===========================================

* "Welcome to Zammad!", there you need to create your admin user and you need to invite other agents.
* "Welcome to Zammad!", there you need to create your admin user and invite other agents.


SSH into the machine
Expand Down
2 changes: 1 addition & 1 deletion general-search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Search Cheat Sheet

Tickets, articles (with attachments), users and organizations are indexed by default.

A simple search for all objects can be: "something". If you want to search for objetcs with certain attributes you can use "attribute: something".
A simple search for all objects can be: "something". If you want to search for objects with certain attributes you can use "attribute: something".

* For example: "customer: some name"

Expand Down
18 changes: 9 additions & 9 deletions general-ticket.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
All about the Ticket
********************
Everything about the ticket
***************************

A ticket is a container for a conversation with the customer about one dedicated topic/issue.

Ticket States
Ticket states
=============

In default setup Zammad has the following ticket states:

* new

* Ticket is created by customer, no agent has sent out a response to the customer right now
* Ticket has been created by a customer, no agent has sent out a response to the customer yet
* If an agent replies to the customer, the ticket will change its state to "open" automatically

* open
Expand All @@ -32,17 +32,17 @@ In default setup Zammad has the following ticket states:

* closed

* Ticket is solved/finished, no further action/attention needed
* Ticket has been solved/finished, no further action/attention needed


Ticket Colors
Ticket colors
=============

On almost every place in the UI where a ticket is shown you will see a colored circle. The color shows you if the ticket needs attention:
Almost anywhere a ticket is being shown you will see a colored circle. The color tells you if the ticket needs attention:

* Orange

* Ticket is created, somebody needs to work on it
* Ticket has been created, somebody needs to work on it
* Pending reminder of ticket has been reached, somebody needs to work on it

* Red
Expand All @@ -55,4 +55,4 @@ On almost every place in the UI where a ticket is shown you will see a colored c

* Dark gray

* Pending reminder or pending close is set but not yet reached, no further action/attention needed right now
* Pending reminder or pending close has been set but not yet reached, no further action/attention needed right now
2 changes: 1 addition & 1 deletion getting-started-first-steps.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
First Steps
First steps
***********

After installing Zammad, open http://localhost:3000 with your browser and follow the installation wizard.
Expand Down
6 changes: 3 additions & 3 deletions install-centos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ Add Zammad & epel-release RPM repos and install RPM
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.
* "Welcome to Zammad!", there you need to create your admin user and invite other agents.


On remote server:
=================

Add your fully qualified domain name or public IP to servername directive in your webserver configuration and restart your webserver.
The installer will give you a hint where Zammads webserver config file is located.
Add your fully qualified domain name or public IP to server name directive in your web server configuration and restart your web server.
The installer will give you a hint where Zammad's web server config file is located.


You can manage the Zammad services manually:
Expand Down
10 changes: 5 additions & 5 deletions install-debian.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Currently we support Debian 8
Prerequisites
=============

Be sure to use an UTF-8 locale or PostgreSQL will not install.
Be sure to use an UTF-8 locale or PostgreSQL will not install.

Check locale
------------
Expand All @@ -27,7 +27,7 @@ Set locale
echo "LANG=en_US.UTF-8" > /etc/default/locale


Add Zammad DEB Repo and install
Add Zammad DEB repo and install
===============================

::
Expand All @@ -41,14 +41,14 @@ Add Zammad DEB Repo and install
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.
* "Welcome to Zammad!", there you need to create your admin user and invite other agents.


On remote server:
=================

Add your fully qualified domain name or public IP to servername directive in your webserver configuration and restart your webserver.
The installer will give you a hint where Zammads webserver config file is located.
Add your fully qualified domain name or public IP to server name directive in your web server configuration and restart your web server.
The installer will give you a hint where Zammad's web server config file is located.


You can manage the Zammad services manually:
Expand Down
8 changes: 4 additions & 4 deletions install-docker-compose.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Install with Docker-compose
Install with Docker-Compose
***************************

Docker is a container-based software framework for automating deployment of applications. Compose is a tool for defining and running multi-container Docker applications.
This repo is meant to be the starting point for somebody who likes to use dockerized multi-container Zammad in production.
The Zammad Docker image uses the stable branch of Zammads GIT repo.
The Zammad Docker image uses the stable branch of Zammad's Git repo.

The Docker images are hosted on Dockerhub:

Expand Down Expand Up @@ -49,7 +49,7 @@ Start Zammad using DockerHub images
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.
* "Welcome to Zammad!", there you need to create your admin user and invite other agents.


Maintenance
Expand All @@ -68,7 +68,7 @@ Start Zammad building Docker images locally with development branch

* GIT_BRANCH=develop docker-compose -f docker-compose-build.yml up

Recreate locally build images
Recreate locally built images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* GIT_BRANCH=develop docker-compose -f docker-compose-build.yml build --no-cache
Expand Down
10 changes: 5 additions & 5 deletions install-elasticsearch.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Set up Elasticsearch
********************

We use Elasticsearch for the awesome search in Zammad.
This manual uses "zammad" command which is only available if you installed Zammad from one of our package repos.
We use Elasticsearch for the awesome search in Zammad.
This manual uses the "zammad" command which is only available if you installed Zammad from one of our package repos.

Install Elasticsearch and its Attachment plugin
===============================================
Expand Down Expand Up @@ -120,7 +120,7 @@ Extra Elasticsearch index name space (optional)

zammad run rails r "Setting.set('es_index', Socket.gethostname + '_zammad')"

Ignore certain file extentions for indexing (optional)
Ignore certain file extensions for indexing (optional)
------------------------------------------------------

::
Expand All @@ -139,8 +139,8 @@ Using Elasticsearch on another server
=====================================

Elasticsearch can also be installed on another server but you have to know that this is insecure out of the box because Elasticsearch has no authentication.
For this reason you should run elasticsearch on 127.0.0.1 and use a reverse proxy with authentification to access it from Zammad.
For this reason you should run elasticsearch on 127.0.0.1 and use a reverse proxy with authentication to access it from Zammad.

You can find a Nginx reverse proxy config here:
You can find an Nginx reverse proxy config here:

* https://github.com/zammad/zammad/blob/develop/contrib/nginx/elasticsearch.conf
2 changes: 1 addition & 1 deletion install-source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ For MySQL (note, the option says "without ... postgres")
6. Go to http://localhost:3000 and you'll see:
==============================================

* "Welcome to Zammad!", there you need to create your admin user and you need to invite other agents.
* "Welcome to Zammad!", there you need to create your admin user and invite other agents.
6 changes: 3 additions & 3 deletions install-suse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,16 @@ Add Zammad RPM repo and install
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.
* "Welcome to Zammad!", there you need to create your admin user and invite other agents.

Note: Make sure that the firewall is not blocking port 80 (configure firewall via "yast firewall" or stop it via "systemctl stop SuSEfirewall2").


On remote server:
=================

Add your fully qualified domain name or public IP to servername directive in your webserver configuration and restart your webserver.
The installer will give you a hint where Zammads webserver config file is located.
Add your fully qualified domain name or public IP to server name directive in your web server configuration and restart your web server.
The installer will give you a hint where Zammad's web server config file is located.


You can manage the Zammad services manually:
Expand Down
8 changes: 4 additions & 4 deletions install-ubuntu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Currently we support Ubuntu 16.04
Prerequisites
=============

Be sure to use an UTF-8 locale or PostgreSQL will not install.
Be sure to use an UTF-8 locale or PostgreSQL will not install.

Check locale
------------
Expand Down Expand Up @@ -42,14 +42,14 @@ Add Zammad DEB Repo and install
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.
* "Welcome to Zammad!", there you need to create your admin user and invite other agents.


On remote server:
=================

Add your fully qualified domain name or public IP to servername directive in your webserver configuration and restart your webserver.
The installer will give you a hint where Zammads webserver config file is located.
Add your fully qualified domain name or public IP to server name directive in your web server configuration and restart your web server.
The installer will give you a hint where Zammad's web server config file is located.


You can manage the Zammad services manually:
Expand Down
18 changes: 9 additions & 9 deletions install-update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Source update

**Note: Please backup your Zammad instance before update!**

1. Download Zammad on your system
1. Download Zammad to your system
---------------------------------

You can directly download Zammad from https://ftp.zammad.com/ or use the direct URL to get the latest stable release via https://ftp.zammad.com/zammad-latest.tar.gz
Expand Down Expand Up @@ -36,7 +36,7 @@ You can directly download Zammad from https://ftp.zammad.com/ or use the direct
zammad@shell> bundle install --without test development postgres


3. Stop zammad services
3. Stop Zammad services
-----------------------

Stop the application server, websocket server and scheduler.
Expand All @@ -51,7 +51,7 @@ Stop the application server, websocket server and scheduler.
zammad@shell> rake db:migrate
zammad@shell> rake assets:precompile

5. Start zammad services
5. Start Zammad services
------------------------

Start the application server, websocket server and scheduler.
Expand Down Expand Up @@ -97,7 +97,7 @@ CentOS7

shell> sudo yum update zammad

**Note: The package will automatically execute maintanance task like database changes and will restart Zammad for you.**
**Note: The package will automatically execute maintenance tasks like database changes and will restart Zammad for you.**


4. Start Zammad
Expand All @@ -108,8 +108,8 @@ CentOS7
shell> sudo systemctl start zammad


5. Go and login to Zammad
-------------------------
5. Go and log in to Zammad
--------------------------



Expand Down Expand Up @@ -157,7 +157,7 @@ Ubuntu
shell> apt-get update
shell> apt-get upgrade

**Note: The package will automatically execute maintanance task like database changes and will restart Zammad for you.**
**Note: The package will automatically execute maintenance tasks like database changes and will restart Zammad for you.**

4. Start Zammad
----------------
Expand All @@ -167,5 +167,5 @@ Ubuntu
shell> sudo systemctl start zammad


5. Go and login to Zammad
-------------------------
5. Go and log in to Zammad
--------------------------
Loading

0 comments on commit d0de573

Please sign in to comment.