DevFW-CICD/website-and-documentation
23
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
eDF documentation-as-code repository. Also 'website' as based on Hugo it is rendered statically. https://docs.edp.buildth.ing/
61 commits 14 branches 5 tags 53 MiB
Find a file
Evgenii Dominov d93575b9f2 Pull request #4: Added article about Backstage and it's plugins 
Merge in IPCEICIS/ipceicis-developerframework from Backstage-description-and-existing-plugins to development

* commit 'e23cf8c578':
  Added article about Backstage and it's plugins
2024-09-26 08:57:49 +00:00
.devcontainer feat(c4-model): added likec4 system model 2024-09-10 11:27:20 +00:00
assets fix(README): better Docsy installation description 2024-09-03 10:39:41 +02:00
content/en Added article about Backstage and it's plugins 2024-09-26 10:56:54 +02:00
layouts chore(hugo-theme): moved to docsy. Started from https://github.com/google/docsy-example and ported all ipceicis content to there. removed all docsy example stuff 2024-08-05 11:56:38 +02:00
resources doc( architecture): WiP minor changes on model 2024-09-15 22:43:38 +02:00
.gitignore chore(hugo): renderer folder removed 2024-07-30 16:26:55 +02:00
.gitmodules chore(documentation-base): Initial commit with Hugo devcontainer and RELEARN theme installed - just open the devconatiner and start editing! 2024-07-30 11:12:09 +02:00
config.yaml chore(hugo-theme): moved to docsy. Started from https://github.com/google/docsy-example and ported all ipceicis content to there. removed all docsy example stuff 2024-08-05 11:56:38 +02:00
go.mod chore(hugo-theme): moved to docsy. Started from https://github.com/google/docsy-example and ported all ipceicis content to there. removed all docsy example stuff 2024-08-05 11:56:38 +02:00
go.sum chore(hugo-theme): moved to docsy. Started from https://github.com/google/docsy-example and ported all ipceicis content to there. removed all docsy example stuff 2024-08-05 11:56:38 +02:00
hugo.toml chore(): a bit more history addedand plantuml enabled for nice architecture drawings :-) 2024-09-02 16:13:54 +02:00
otc.conf doc(c4): how to use added 2024-09-10 11:30:21 +00:00
README.md fix(README): better Docsy installation description 2024-09-03 10:39:41 +02:00

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 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:

Steps 4/5 in Visual Studio Code

Reopen in Container

vsc-f1

Hugo server is running and (typically) listens to localhost:1313

After some installation time you have:

vsc-hugo

Steps 6 in a web browser

browser