mirror of
https://gitlab.com/Chill-Projet/chill-bundles.git
synced 2025-11-23 04:17:45 +00:00
Change all content from rst format to markdown and correct spelling/grammar
This commit is contained in:
54
docs/source/index.md
Normal file
54
docs/source/index.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# Welcome to Chill documentation!
|
||||
|
||||
Chill is a free software for social workers.
|
||||
|
||||
Chill relies on the php framework [Symfony](http://symfony.com).
|
||||
|
||||
## Let's talk together!
|
||||
|
||||
You can talk to developers using the matrix room: [https://app.element.io/#/room/#chill-social-admin:matrix.org](https://app.element.io/#/room/#chill-social-admin:matrix.org)
|
||||
|
||||
## Contribute
|
||||
|
||||
* [Issue tracker](https://gitlab.com/groups/Chill-project/issues) You may want to dispatch an issue to multiple projects. If you do not know in which project your bug / feature request should be located, use the project Chill-Main.
|
||||
|
||||
## User manual
|
||||
|
||||
A user manual exists in French and currently focuses on describing the main concept of the software.
|
||||
|
||||
[Read (and contribute) to the manual](https://fr.wikibooks.org/wiki/Chill)
|
||||
|
||||
## Available bundles
|
||||
|
||||
* Chill-app | https://gitlab.com/Chill-project/Chill-app This is the skeleton of the project. It contains only a bit of code but provides plenty of information on the configuration of your instance;
|
||||
* Chill-bundles: this repository contains all the main bundles. This means:
|
||||
* MainBundle: the main framework,
|
||||
* PersonBundle: to deal with persons,
|
||||
* CustomFieldsBundle: to add custom fields to some entities,
|
||||
* ActivityBundle: to add activities to people,
|
||||
* AsideActivityBundle: to add annex activities such as meetings/trainings not related to a person,
|
||||
* BudgetBundle: to add budget elements to a person's file,
|
||||
* DocGeneratorBundle: to generate documents from templates,
|
||||
* JobBundle: to add information related to employment/ professional training to a person's file,
|
||||
* ReportBundle: to add a report to a person's file,
|
||||
* EventBundle: to create events and add persons that will be participating,
|
||||
* DocStoreBundle: to store documents to people, but also to other entities,
|
||||
* TaskBundle: to register tasks within a person's file or accompanying course,
|
||||
* ThirdPartyBundle: to register third parties,
|
||||
|
||||
You will also found the following projects :
|
||||
|
||||
* The website https://chill.social : https://gitlab.com/Chill-project/chill.social
|
||||
|
||||
And various projects to build docker containers with Chill.
|
||||
|
||||
## Licence
|
||||
|
||||
The project is available under the [GNU AFFERO GENERAL PUBLIC LICENSE v3](http://www.gnu.org/licenses/agpl-3.0.html).
|
||||
|
||||
This documentation is published under the [GNU Free Documentation License (FDL) v1.3](http://www.gnu.org/licenses/fdl-1.3.html)
|
||||
|
||||
---
|
||||
|
||||
*Copyright (C) 2014 Champs Libres Cooperative SC
|
||||
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".*
|
||||
Reference in New Issue
Block a user