GradleUp site

.devcontainer/Dockerfile

@@ -0,0 +1,4 @@
+FROM python:3.10.4-slim-buster
+
+RUN apt-get update
+RUN apt-get install -y libsass-dev build-essential libcairo2 git libpango-1.0-0 libpangoft2-1.0-0 pangocairo-1.0 pngquant

.devcontainer/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-2024 Kento Shimada, Oleg Nenashev, and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

.devcontainer/devcontainer.json

@@ -0,0 +1,31 @@
+// Credits - https://github.com/hitsumabushi845/MkDocs-with-Remote-Containers
+{
+    "name": "Material for MkDocs",
+    "dockerFile": "Dockerfile",
+    "customizations": {
+      "vscode": {
+        // Set *default* container specific settings.json values on container create.
+        "settings": {
+          "terminal.integrated.shell.linux": "/bin/bash",
+          "debug.javascript.usePreview": false
+        },
+        // Add the IDs of extensions you want installed when the container is created.
+        "extensions": [
+          "yzhang.markdown-all-in-one",
+          "redhat.vscode-yaml",
+          "shardulm94.trailing-spaces",
+          "oderwat.indent-rainbow",
+          "msjsdiag.debugger-for-chrome"
+        ],
+      },
+    },
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    "forwardPorts": [
+      8000
+    ],
+    // Use 'postCreateCommand' to run commands after the container is created.
+    "postCreateCommand": "pip3 install -r .devcontainer/requirements.txt "
+    // Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
+    //"remoteUser": "vscode"
+  }
+

.devcontainer/requirements.txt

@@ -0,0 +1,34 @@
+Markdown==3.5
+MarkupSafe==2.1.3
+mergedeep==1.3.4
+mdx_truly_sane_lists==1.3
+mkdocs==1.5.3
+mkdocs-autorefs==0.5.0
+mkdocs-macros-plugin==1.0.5
+mkdocs-material==9.5.17
+mkdocs-material[imaging]==9.5.17
+mkdocs-multirepo-plugin==0.6.3
+mkdocs-redirects==1.2.1
+mkdocs-extra-sass-plugin==0.1.0
+mkdocs-render-swagger-plugin==0.1.1
+mkdocs-same-dir==0.1.3
+mkdocs-pdf==0.1.1
+livereload==2.6.3
+lxml==4.9.3
+click==8.1.7
+dacite==1.8.1
+ghp-import==2.1.0
+jinja2==3.1.2
+mypy-extensions==1.0.0
+packaging==23.2
+pathspec==0.11.2
+platformdirs==3.11.0
+python-dateutil==2.8.2
+python-slugify==8.0.1
+pyyaml==6.0.1
+pyyaml-env-tag==0.1
+six==1.16.0
+text-unidecode==1.3
+typing-extensions==4.8.0
+typing-inspect==0.8.0
+watchdog==3.0.0

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @GradleUp/admins

.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: Continuous Integration
+
+on:
+  # We have deploy there
+  # push:
+  #  branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  workflow_dispatch:
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: "true"
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2 
+        with:
+            registry: ghcr.io
+            username: ${{ github.repository_owner }}
+            password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build in the dev container image
+        uses: devcontainers/ci@v0.3
+        with:
+            imageName: ghcr.io/oleg-nenashev/oleg-nenashev-site-builder
+            cacheFrom: ghcr.io/oleg-nenashev/oleg-nenashev-site-builder
+            push: never
+            runCmd: |
+              mkdocs build
+            env: |
+              FULL_BUILD=true

.github/workflows/deploy.yml

@@ -0,0 +1,79 @@
+name: Deploy to GitHub Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: "true"
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2 
+        with:
+            registry: ghcr.io
+            username: ${{ github.repository_owner }}
+            password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build in the dev container image
+        uses: devcontainers/ci@v0.3
+        with:
+            imageName: ghcr.io/oleg-nenashev/oleg-nenashev-site-builder
+            cacheFrom: ghcr.io/oleg-nenashev/oleg-nenashev-site-builder
+            push: never
+            runCmd: |
+              mkdocs build
+            env: |
+              FULL_BUILD=true
+
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v1
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -0,0 +1,4 @@
+# MkDocs
+.cache
+_site
+temp_dir

.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+    "cSpell.words": [
+        "CNCF",
+        "Devoxx",
+        "Dynatrace",
+        "FOSS",
+        "Heisenbug",
+        "Kubecon",
+        "Reengineering",
+        "toolkits"
+    ]
+}

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing to the Site
+
+Any contributions, typo fixes and patches are welcome!
+The content is located inside this repository and in the
+linked repositories.
+
+The website engine, tooling and configuration are also open source,
+feel free to reuse and contribute.
+If you want to work together and build a template on the top of Material for MkDocs,
+let [@oleg-nenashev](https://github.com/oleg-nenashev) know :)
+
+## Quick Start
+
+There is a Dev Container definition available in this repository.
+It is highly recommended to use this image to
+provision the developer environment.
+
+For the local development without full rebuild:
+
+```shell
+FULL_BUILD=false mkdocs serve
+```
+
+## Under the Hood
+
+The site is built with [MkDocs](https://www.mkdocs.org/),
+[MkDocs Multirepo Plugin](https://github.com/jdoiro3/mkdocs-multirepo-plugin/tree/main),
+and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material).
+For development, everything is powered by Dev Containers and GitHub Actions.
+
+## License
+
+<p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://github.com/oleg-nenashev/oleg-nenashev">This site</a> by the <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://github.com/GradleUp">GradleUp team and contributors</a> is licensed under <a href="https://creativecommons.org/licenses/by/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC BY 4.0<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1" alt=""></a></p>