1
0
mirror of https://github.com/LaCasemate/fab-manager.git synced 2024-12-11 22:24:21 +01:00
fab-manager/doc/README.md

56 lines
1.7 KiB
Markdown
Raw Normal View History

2020-04-08 17:03:29 +02:00
# Fab-Manager's documentations
### User's manual
The following guide describes what you can do and how to use Fab-manager.
2021-02-22 19:26:38 +01:00
- [Français](fr/guide_utilisation_fab_manager_v4.7.pdf)
2020-04-08 17:03:29 +02:00
2020-04-14 10:05:48 +02:00
### General documentation
Translators, contributors, developers and system administrators should start by reading this document.
- [Read first](../README.md)
2020-04-08 17:03:29 +02:00
### System administrator
2020-04-14 10:05:48 +02:00
The following guides are designed for the people that perform software maintenance.
2020-04-08 17:44:48 +02:00
- [Setup and update a production environment](production_readme.md)
2020-04-08 17:03:29 +02:00
- [Configuring the environment variables](environment.md)
- [Known issues with Fab-Manager](known-issues.md)
- [Advanced PostgreSQL usage](postgresql_readme.md)
- [Connecting a SSO using oAuth 2.0](sso_with_github.md)
2020-04-14 10:05:48 +02:00
- [Upgrade from Fab-manager v1.0](upgrade_v1.md)
2020-04-08 17:03:29 +02:00
#### Upgrades procedures
- [PostgreSQL](postgres_upgrade.md)
- [ElasticSearch](elastic_upgrade.md)
2020-04-15 15:44:18 +02:00
### Translator's documentation
If you intend to translate Fab-manager to a new, or an already supported language, you'll find here the information you need.
- [Guide for translators](translation_readme.md)
2020-04-08 17:03:29 +02:00
### Developer's documentation
2020-04-14 10:05:48 +02:00
The following guides should help those who want to contribute to the code.
2020-12-29 13:13:48 +01:00
#### Architecture
- [Code architecture](architecture.md)
2020-04-08 17:03:29 +02:00
#### How to setup a development environment
- [With docker-compose](development_readme.md)
2020-04-14 10:05:48 +02:00
2020-04-08 17:03:29 +02:00
- [With vagrant](virtual-machine.md)
#### Externals
- [ElasticSearch mapping](elasticsearch.md)
- [Changing the database system](postgresql_readme.md#using-another-dbms)
2020-04-08 17:03:29 +02:00
#### Diagrams
2020-04-08 17:53:52 +02:00
- [Database diagram](database.svg)
2020-04-08 17:03:29 +02:00
2020-04-08 17:53:52 +02:00
- [Class diagram](class-diagram.svg)
2020-04-08 17:03:29 +02:00
2020-04-08 17:53:52 +02:00
- [Javascript dependencies](js-modules-dependencies.svg)
2020-04-08 17:03:29 +02:00
2020-06-16 16:47:38 +02:00
- [Ruby dependencies](gem-dependencies.svg)