chore(documentation-base): added installation illustration to the README

This commit is contained in:
Stephan Lo 2024-07-30 11:39:14 +02:00
parent fabab52d8d
commit 86d0c47dd9
15 changed files with 108 additions and 90 deletions

View file

@ -13,12 +13,12 @@ The repo contains a [Hugo `.devcontainer`-defintion](https://containers.dev/) so
To get a locally running documentation editing and presentation environment, follow these steps:
1. open a terminal on your local box
1. Set `REPO=ipceicis-developerframework`
1. Clone this repo: `git clone --recurse-submodules https://bitbucket.telekom-mms.com/scm/ipceicis/${REPO}.git `
1. Change to the repo working dir: `cd ${REPO}`
1. Open the repo in an [Devcontainer-aware tool/IDE](https://containers.dev/supporting) (e.g. `code .`)
1. Start the `devcontainer` (in VSC it's `F1 + Reopen in Devcontainer`)
1. When the container is up & running just open your browser with `http://localhost:1313/`
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
@ -30,4 +30,22 @@ So for editing content just goto the `content`-folder and edit content arrording
### Commiting
After having finished a unit of work commit and push.
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
![terminal](.devcontainer/terminal.png)
### Steps 5 and 6 in Visual Studio Code
![vsc-f1](.devcontainer/vsc-f1.png)
![vsc-hugo](.devcontainer/vsc-hugo.png)
### Steps 7 in a web browser
![browser](.devcontainer/browser.png)