website-and-documentation/README.md

IPCEICIS-DeveloperFramework Documentation

This repo contains business and architectural design and documentation of the DeveloperFramework subproject of IPCEI-CIS.

How to read and contribute to this documentation locally

The documentation is done in Hugo-format.

The repo contains a Hugo .devcontainer-defintion so that you just have to run locally an IDE which is devcontainer aware, e.g. Visual Studio code.

Installation

To get a locally running documentation editing and presentation environment, follow these steps:

1. open a terminal on your local box
2. clone this repo: git clone https://bitbucket.telekom-mms.com/scm/ipceicis/ipceicis-developerframework.git
3. change to the repo working dir: cd ipceicis-developerframework
4. open the repo in an Devcontainer-aware tool/IDE (e.g. code .)
5. start the devcontainer (in VSC it's F1 + Reopen in Devcontainer)
6. when the container is up & running just open your browser with http://localhost:1313/

Editing

Documentation language

The documentation is done in Relearn-Syntax.

So for editing content just goto the content-folder and edit content arrording to the documentation language spec

Commiting

After having finished a unit of work commit and push.

Installation steps illustrated

When you run the above installation, the outputs could typically look like this:

Steps 1-5 in the terminal

Steps 5 and 6 in Visual Studio Code

Steps 7 in a web browser