Initiate the reference documentation - Githubissues

OsgiliathEnterprise / platform

Platform to deploy an entire IS with all its Mail servers, CRMs, engineering suite, ...

https://osgiliathenterprise.github.io/platform/reference/toc.html

GNU Lesser General Public License v3.0

4 stars 5 forks source link

Initiate the reference documentation #4

Closed Tcharl closed 4 years ago

Tcharl commented 4 years ago

When a Change Needs a Design Proposal

Reference documentation template shall be setup very early in the lifecycle of the project so that it is easy to keep it up to date

Why We Use This Process

Documentation is really important to sell a product

Motivation

In order to know the benefits of Osgiliath stack,
As a developper,
I want to contribute to documentation.

Specification

Use Asciidoctor as templating engine
Use maven site for generation
Use Github action for CI/CD
Use github pages as deployement target