51 lines
1.8 KiB
Markdown
51 lines
1.8 KiB
Markdown
# 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](https://gohugo.io).
|
|
|
|
The repo contains a [Hugo `.devcontainer`-defintion](https://containers.dev/) 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. Set `REPO=ipceicis-developerframework`
|
|
3. Clone this repo: `git clone --recurse-submodules https://bitbucket.telekom-mms.com/scm/ipceicis/${REPO}.git `
|
|
4. Change to the repo working dir: `cd ${REPO}`
|
|
5. Open the repo in an [Devcontainer-aware tool/IDE](https://containers.dev/supporting) (e.g. `code .`)
|
|
6. Start the `devcontainer` (in VSC it's `F1 + Reopen in Devcontainer`)
|
|
7. When the container is up & running just open your browser with `http://localhost:1313/`
|
|
|
|
### Editing
|
|
|
|
#### Documentation language
|
|
|
|
The documentation is done in [Relearn-Syntax](https://mcshelby.github.io/hugo-theme-relearn/index.html).
|
|
|
|
So for editing content just goto the `content`-folder and edit content arrording to the [documentation language spec](https://mcshelby.github.io/hugo-theme-relearn/cont/index.html)
|
|
|
|
### 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
|
|
|
|
|