diff --git a/.devcontainer/browser.png b/.devcontainer/browser.png new file mode 100644 index 0000000..202f609 Binary files /dev/null and b/.devcontainer/browser.png differ diff --git a/.devcontainer/terminal.png b/.devcontainer/terminal.png new file mode 100644 index 0000000..ffc7fc1 Binary files /dev/null and b/.devcontainer/terminal.png differ diff --git a/.devcontainer/vsc-f1.png b/.devcontainer/vsc-f1.png new file mode 100644 index 0000000..38bc4fa Binary files /dev/null and b/.devcontainer/vsc-f1.png differ diff --git a/.devcontainer/vsc-hugo.png b/.devcontainer/vsc-hugo.png new file mode 100644 index 0000000..71bc7f1 Binary files /dev/null and b/.devcontainer/vsc-hugo.png differ diff --git a/README.md b/README.md index 24998ab..a519e9f 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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) \ No newline at end of file diff --git a/public/404.html b/public/404.html index f8db4fc..f193df5 100644 --- a/public/404.html +++ b/public/404.html @@ -17,17 +17,17 @@ 404 Page not found :: IPCEI-CIS Developer Framework Documentation - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/public/css/chroma-auto.css b/public/css/chroma-auto.css index cc29ec5..c52a045 100644 --- a/public/css/chroma-auto.css +++ b/public/css/chroma-auto.css @@ -1,2 +1,2 @@ -@import "chroma-relearn-light.css?1722329197" screen and (prefers-color-scheme: light); -@import "chroma-relearn-dark.css?1722329197" screen and (prefers-color-scheme: dark); +@import "chroma-relearn-light.css?1722331657" screen and (prefers-color-scheme: light); +@import "chroma-relearn-dark.css?1722331657" screen and (prefers-color-scheme: dark); diff --git a/public/css/format-print.css b/public/css/format-print.css index 142fe52..8fd236b 100644 --- a/public/css/format-print.css +++ b/public/css/format-print.css @@ -1,5 +1,5 @@ -@import "theme-relearn-light.css?1722329197"; -@import "chroma-relearn-light.css?1722329197"; +@import "theme-relearn-light.css?1722331657"; +@import "chroma-relearn-light.css?1722331657"; #R-sidebar { display: none; diff --git a/public/css/print.css b/public/css/print.css index 14fcee3..36e199f 100644 --- a/public/css/print.css +++ b/public/css/print.css @@ -1 +1 @@ -@import "format-print.css?1722329197"; +@import "format-print.css?1722331657"; diff --git a/public/css/swagger.css b/public/css/swagger.css index 49e1a5c..2c507fc 100644 --- a/public/css/swagger.css +++ b/public/css/swagger.css @@ -1,7 +1,7 @@ /* Styles to make Swagger-UI fit into our theme */ -@import "fonts.css?1722329197"; -@import "variables.css?1722329197"; +@import "fonts.css?1722331657"; +@import "variables.css?1722331657"; body{ line-height: 1.574; diff --git a/public/css/theme-auto.css b/public/css/theme-auto.css index 14c57a4..e5e738f 100644 --- a/public/css/theme-auto.css +++ b/public/css/theme-auto.css @@ -1,2 +1,2 @@ -@import "theme-relearn-light.css?1722329197" screen and (prefers-color-scheme: light); -@import "theme-relearn-dark.css?1722329197" screen and (prefers-color-scheme: dark); +@import "theme-relearn-light.css?1722331657" screen and (prefers-color-scheme: light); +@import "theme-relearn-dark.css?1722331657" screen and (prefers-color-scheme: dark); diff --git a/public/css/variant.css b/public/css/variant.css index 6142a7e..3378681 100644 --- a/public/css/variant.css +++ b/public/css/variant.css @@ -1,4 +1,4 @@ -@import "variables.css?1722329197"; +@import "variables.css?1722331657"; html { color-scheme: only var(--INTERNAL-BROWSER-theme); diff --git a/public/index.html b/public/index.html index 7dc41cc..18b0c3c 100644 --- a/public/index.html +++ b/public/index.html @@ -21,17 +21,17 @@ IPCEI-CIS Developer Framework Documentation - - - - - - - - - - - + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/public/tags/index.html b/public/tags/index.html index 6bd533b..7963bc3 100644 --- a/public/tags/index.html +++ b/public/tags/index.html @@ -17,17 +17,17 @@ Tags :: IPCEI-CIS Developer Framework Documentation - - - - - - - - - - - + + + + + + + + + + + - - - - - - + + + + + + - - - + + +