Add Contribute doc authored by Daniel Palomar's avatar Daniel Palomar
...@@ -30,3 +30,38 @@ Which entities of OTRS we use in the integrations? ...@@ -30,3 +30,38 @@ Which entities of OTRS we use in the integrations?
* [Article](entities/article) * [Article](entities/article)
* [DynamicField](entities/DynamicField) * [DynamicField](entities/DynamicField)
* [CustomerUser](entities/CustomerUser) * [CustomerUser](entities/CustomerUser)
-----------------
# Contribute
## Setup
Follow the next intructions to preview the wiki in your computer.
We use [Pyenv](https://github.com/coopdevs/handbook/wiki/Uso-de-pyenv-en-Coopdevs) to manage the Python version and dependencies.
Follow the instructions to install Pyenv and then you must to create a virtualenv called `otrs-somconnexio.wiki`:
```
$ pyenv virtualenv 3.8.2 otrs-somconnexio.wiki
```
Once the virtualenv is created you can install the dependencies:
```
$ pyenv exec pip install -r requirements.txt
```
## Run the preview server
From the wiki directory, run:
```
$ pyenv exec grip
* Running on http://localhost:6419/
```
Open the browser and go to http://localhost:6419.
More details in the [Grip documentation](https://github.com/joeyespo/grip#usage)