https://github.com/simplicitesoftware/module-training

Backoffice for docs2
https://github.com/simplicitesoftware/module-training

Last synced: about 14 hours ago
JSON representation

Backoffice for docs2

• Host: GitHub
• URL: https://github.com/simplicitesoftware/module-training
• Owner: simplicitesoftware
• Created: 2020-12-21T09:22:11.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-06T10:31:27.000Z (2 days ago)
• Last Synced: 2024-11-06T11:33:38.973Z (2 days ago)
• Language: Java
• Size: 107 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

![](https://docs.simplicite.io//logos/logo250.png)

* * *

Sonar Analysis

====================

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=simplicitesoftware_module-training&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=simplicitesoftware_module-training)

Installation instructions

====================

1. deploy a Simplicité instance with internet access

2. navigate to AppStore > Apps > Documentation and click on the Install button

3. clear the cache

4. follow the instructions from the default homepage

**WARNING:** At the moment, the modules takes over the root URL (`/`), deploying a specific instance for this module is highly recommended to avoid interfering with other modules.

`Training` module

============================

The module for the Simplicité Training platform.

This module objective is to offer an easy way to deploy a custom documentation.

It's a *Category* / *Lesson* / *Translations* model with a few additions such as *tags* or *pages*.

The training module not only gives the ability to manage content, but it also serves a Vue.js front end (see the external object *TrnFront*).

The front end is served on the root url of your instance. For further details on the site mapping, see system parameter ```URI_MAPPING```.

More info available on the front end default home page.

Configuration

============================

You can configure the way you handle your content and its indexation. 

For more information, refer to the ```TRN_CONFIG``` system parameter description.

## Content

 

There are two modes available for the content edition: *UI* and *FILESYSTEM*.

### UI mode

This is the default mode. It lets you handle the content on the simplicite interface.

### FILESYSTEM

The *FILESYSTEM* mode will synchronize the content from a folder / git repository in your filesystem. You cannot edit the content from the simplicite interface, it must be done through the synchronization action.

Using a git repository is a handy way to manage the content. The training module provides a service that is able to perform operations to get the latest content from a configured repository. Once the latest content is pulled, the service triggers the synchronization algorithm.

This service can be called from a ci/cd pipeline to create an automated way of synchronizing your content with the latest content of a git repository.