From c1a9a4a0752bceac8f4c4ebdc06718b99ec1e6ca Mon Sep 17 00:00:00 2001 From: Sylvain Date: Fri, 22 Oct 2021 16:50:18 +0200 Subject: [PATCH] reorganized documentation --- README.md | 52 ++++---------------------------------------- doc/README.md | 6 ++++- doc/open_projects.md | 18 +++++++++++++++ doc/plugins.md | 13 +++++++++++ 4 files changed, 40 insertions(+), 49 deletions(-) create mode 100644 doc/open_projects.md create mode 100644 doc/plugins.md diff --git a/README.md b/README.md index 7a108ee3b..0840d78b9 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,6 @@ Fab-manager is the Fab Lab management solution. It provides a comprehensive, web Please visit [fab-manager.com](https://www.fab-manager.com/) for more information about this software and its features. -##### Table of Contents -1. [Contributing](#contributing) -2. [Documentation](#documentation) -3. [Open Projects](#open-projects) -4. [Plugins](#plugins) -5. [Single Sign-On](#sso) - ## Contributing @@ -26,45 +19,8 @@ Contributions are welcome. Please read [the contribution guidelines](CONTRIBUTIN The full documentation is available at [doc.fab.mn](http://doc.fab.mn). - -## Open Projects + +## Copyright -**This configuration is optional.** - -You can configure your Fab-manager to synchronize every project with the [Open Projects platform](https://github.com/sleede/openlab-projects). -It's very simple and straightforward and in return, your users will be able to search over projects from all Fab-manager instances from within your platform. -The deal is fair, you share your projects and as reward you benefits from projects of the whole community. - -If you want to try it, you can visit [this Fab-manager](https://fablab.lacasemate.fr/#!/projects) and see projects from different Fab-managers. - -To start using this awesome feature, there are a few steps: -- send a mail to **contact@fab-manager.com** asking for your Open Projects client's credentials and giving them the name and the URL of your Fab-manager, they will give you an `App ID` and a `secret` -- fill in the value of the keys in Admin > Projects > Settings > Projects sharing -- export your projects to open-projects (if you already have projects created on your Fab-manager, unless you can skip that part) executing this command: `bundle exec rails fablab:openlab:bulk_export` - -**IMPORTANT: please run your server in production mode.** - -Go to your projects gallery and enjoy seeing your projects available from everywhere ! That's all. - - -## Plugins - -Fab-manager has a system of plugins mainly inspired by [Discourse](https://github.com/discourse/discourse) architecture. - -It enables you to write plugins which can: -- have its proper models and database tables -- have its proper assets (js & css) -- override existing behaviours of Fab-manager -- add features by adding views, controllers, ect... - -To install a plugin, you just have to copy the plugin folder which contains its code into the folder `plugins` of Fab-manager. - -You can see an example on the [repo of navinum gamification plugin](https://github.com/sleede/navinum-gamification) - - -## Single Sign-On - -Fab-manager can be connected to a [Single Sign-On](https://en.wikipedia.org/wiki/Single_sign-on) server which will provide its own authentication for the platform's users. -Currently, OAuth 2 is the only supported protocol for SSO authentication. - -For an example of how to use configure an SSO in Fab-manager, please read [sso_with_github.md](doc/sso_with_github.md). +This free software is available under the terms of the [GNU Affero General Public License](LICENSE.md). +Fab-manager is developed by [sleede](https://www.sleede.com/) and the [open-open contributors](https://github.com/sleede/fab-manager/graphs/contributors) of the community. diff --git a/doc/README.md b/doc/README.md index 8c6aa6266..8775de5ee 100644 --- a/doc/README.md +++ b/doc/README.md @@ -26,10 +26,12 @@ The following guides are designed for the people that perform software maintenan - [Advanced PostgreSQL usage](postgresql_readme.md) -- [Connecting a SSO using oAuth 2.0](sso_with_github.md) +- [Connecting an SSO using oAuth 2.0](sso_with_github.md) - [Upgrade from Fab-manager v1.0](upgrade_v1.md) +- [Configuring OpenProjects](open_projects.md) + #### Upgrades procedures - [PostgreSQL](postgres_upgrade.md) - [ElasticSearch](elastic_upgrade.md) @@ -43,6 +45,8 @@ The following guides should help those who want to contribute to the code. #### Architecture - [Code architecture](architecture.md) +- [Plugins](plugins.md) + #### How to setup a development environment - [With docker-compose](development_readme.md) diff --git a/doc/open_projects.md b/doc/open_projects.md new file mode 100644 index 000000000..cd8eab990 --- /dev/null +++ b/doc/open_projects.md @@ -0,0 +1,18 @@ +# Open Projects + +**This configuration is optional.** + +You can configure your Fab-manager to synchronize every project with the [Open Projects platform](https://github.com/sleede/openlab-projects). +It's very simple and straightforward and in return, your users will be able to search over projects from all Fab-manager instances from within your platform. +The deal is fair, you share your projects and as reward you benefits from projects of the whole community. + +If you want to try it, you can visit [this Fab-manager](https://fablab.lacasemate.fr/#!/projects) and see projects from different Fab-managers. + +To start using this awesome feature, there are a few steps: +- send a mail to **contact@fab-manager.com** asking for your Open Projects client's credentials and giving them the name and the URL of your Fab-manager, they will give you an `App ID` and a `secret` +- fill in the value of the keys in Admin > Projects > Settings > Projects sharing +- export your projects to open-projects (if you already have projects created on your Fab-manager, unless you can skip that part) executing this command: `bundle exec rails fablab:openlab:bulk_export` + +**IMPORTANT: please run your server in production mode.** + +Go to your projects gallery and enjoy seeing your projects available from everywhere ! That's all. diff --git a/doc/plugins.md b/doc/plugins.md new file mode 100644 index 000000000..7c87f9ca9 --- /dev/null +++ b/doc/plugins.md @@ -0,0 +1,13 @@ +# Plugins + +Fab-manager has a system of plugins mainly inspired by [Discourse](https://github.com/discourse/discourse) architecture. + +It enables you to write plugins which can: +- have its proper models and database tables +- have its proper assets (js & css) +- override existing behaviours of Fab-manager +- add features by adding views, controllers, ect... + +To install a plugin, you just have to copy the plugin folder which contains its code into the folder `plugins` of Fab-manager. + +You can see an example on the [repo of navinum gamification plugin](https://github.com/sleede/navinum-gamification)