Huge improvements for docs #58

Merged
konrad merged 81 commits from docs into master 2019-02-17 19:53:04 +00:00
1 changed files with 16 additions and 6 deletions
Showing only changes of commit c097b3d84a - Show all commits

View File

@ -23,11 +23,13 @@ This document will explain what these mean and what you can find where.
## Root level
config, links to makefile etc
The root directory is where [the config file](config.md), [Makefile](make.md), license, drone config,
application entry point (`main.go`) and so on are located.
## docker
TBD.
This directory holds additonal files needed to build and run the docker container, mainly service configuration to properly run Vikunja inside a docker
container.
## pkg
@ -57,7 +59,7 @@ TBD.
TBD.
Lot more explanation here.
Needs a lot more explanation here.
### red
@ -77,12 +79,20 @@ TBD.
## REST-Tests
TBD.
Holds all kinds of test files to directly test the api from inside of [jetbrains ide's](https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html).
These files are currently more an experiment, maybe we will drop them in the future to use something we could integrate in the testing process with drone.
Therefore, this has no claim to be complete yet even working, you're free to change whatever is needed to get it working for you.
## templates
TBD.
Holds the email templates used to send plain text and html emails for new user registration and password changes.
## vendor
TBD.
All libraries needed to build Vikunja.
We keep all libraries used for Vikunja around in the `vendor/` folder to still be able to build the project even if
some maintainers take their libraries down like [it happened in the past](https://github.com/jteeuwen/go-bindata/issues/5).
When adding a new dependency, make sure to run `go mod vendor` to put it inside this directory.