Stephan Lo
a7fb376157
All checks were successful
ci / build (push) Successful in 56s
Added two complementary quick-start guides to help new contributors get productive quickly without reading extensive documentation. DOCUMENTOR-GUIDE.md: - Quick-start guide for new documentation contributors - Covers essential workflows: local dev, testing, committing - Provides command reference for common tasks - Links to detailed documentation platform guides - Targets: writers, editors, content contributors - Goal: Productive in 5 minutes README-ARCHITECTURE.md: - Quick-start guide for architecture diagram contributors - Explains LikeC4 setup and project structure - Covers both edp-likec4 (platform) and doc-likec4 (meta-docs) projects - Provides regeneration workflow for webcomponents - Targets: architects, system designers, technical writers - Goal: Productive diagram editing in 5 minutes These guides complement the detailed documentation in content/en/docs/documentation/ by providing a fast-track onboarding path. New contributors can start with these quick-start guides and refer to detailed documentation as needed. Documentation hierarchy: 1. Quick-start (these guides) - Get started in minutes 2. Full guides (content/en/docs/documentation/) - Comprehensive workflows 3. Architecture diagrams - Visual learning and exploration Benefits: - Reduced onboarding time for new team members - Self-service documentation for common tasks - Clear separation between quick reference and detailed guides - Consistent documentation patterns across roles |
||
|---|---|---|
| .devcontainer | ||
| .github/workflows | ||
| .vscode | ||
| assets | ||
| content/en | ||
| layouts | ||
| resources | ||
| scripts | ||
| static | ||
| .dockerignore | ||
| .env.versions | ||
| .gitignore | ||
| .gitmodules | ||
| .htmltest.yml | ||
| .htmlvalidate.json | ||
| .markdownlint.json | ||
| .markdownlintignore | ||
| config.yaml | ||
| devbox.json | ||
| devbox.lock | ||
| DOCKER.md | ||
| Dockerfile | ||
| DOCUMENTOR-GUIDE.md | ||
| edgeconnectdeployment.yaml | ||
| go.mod | ||
| go.sum | ||
| hugo.toml | ||
| k8s-deployment.yaml | ||
| LIKEC4-QUICKSTART.md | ||
| package-lock.json | ||
| package.json | ||
| README-ARCHITECTURE.md | ||
| README-developer.md | ||
| README.md | ||
| RELEASE.md | ||
| Taskfile.yml | ||
| TESTING.md | ||
| VERSIONS.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.
Hugo is a static site renderer - so to get the documentation site presented you need a running Hugo processor. Therefore there is
- either a Hugo
.devcontainer-definition - just run a devcontainer aware IDE or CLI, e.g. Visual Studio code - or a Hugo
Devbox-definition - in this case just run a devbox shell
Local installation of the Hugo documentation system
We describe two possible ways (one with devcontainer, one with devbox) to get the Hugo-documentation system locally running.
For both prepare the following three steps:
- open a terminal on your local box
- clone this repo:
git clone https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW/website-and-documentation - change to the repo working dir:
cd website-and-documentation
Possibility 1: Hugo in a devcontainer
devcontainers are running containers as virtual systems on your local box. The defintion is in the .devcontainer folder.
Thus as preliminary you need a container daemon running, e.g. Docker.
There are several options to create and run the devcontainer - we present here two:
Option 1: Run the container triggered by and connected to an IDE, e.g. VS Code
- open the repo in an Devcontainer-aware tool/IDE (e.g.
code .) - start the
devcontainer(in VSC it'sF1 + Reopen in Devcontainer) - when the container is up & running just open your browser with
http://localhost:1313/
Option 2: Run the container natively
An alternative to get the container image is the devcontainer CLI, then you can run the devcontainer without VS Code. Thus as preliminary you need to do the install steps of the devconatiner cli.
- start the devcontainer by running:
devcontainer up --workspace-folder . - find out the IP address of the devconatiner by using
docker psanddocker inspect <id of container> - when the container is up & running just open your browser with
http://<DOCKER IP>:1313/
Possibility 2: Hugo in a devbox
Devboxes are locally isolated environments, managed by the Nix package manager. So first prepare the devbox.
Then
devbox shell- In the shell:
hugo serve
Editing
Documentation language
The documentation is done in Docsy-Theme.
So for editing content just goto the content-folder and edit content arrording to the Docsy documentation
Commiting
After having finished a unit of work commit and push.
Annex
Installation steps illustrated
When you run the above installation, the outputs could typically look like this:
In Visual Studio Code
Reopen in Container
Hugo server is running and (typically) listens to localhost:1313
After some installation time you have:
Final result in a web browser
