bump up docs (#226)

fix typos

.devcontainer/devcontainer.json

@@ -0,0 +1,24 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/alpine
+{
+	"name": "Alpine",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/base:alpine-3.17",
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	"features": {
+		"ghcr.io/devcontainers/features/common-utils:2": {
+
+		},
+		"ghcr.io/devcontainers-contrib/features/asdf-package:1": {
+			"plugin": "argocd"
+		}
+	}
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "uname -a",
+	// Configure tool-specific properties.
+	// "customizations": {},
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -13,33 +13,33 @@ Thank you for opening an issue.
 --->
 
 
-### Used Release
+### Used release
 
 
-### Debug Output
+### Debug output
 <!--Please provider a link to a GitHub Gist containing the complete debug output. Please do NOT paste the debug output in the issue; just paste a link to the Gist. And Please check the Debug Output for any Plain Text Credentials.-->
 
-### Panic Output
+### Panic output
 <!--If produced a panic, please provide a link to a GitHub Gist containing the output of the `crash.log`.-->
 
-### Expected Behavior
+### Expected behavior
 What should have happened?
 
-### Actual Behavior
+### Actual behavior
 What actually happened?
 
-### Steps to Reproduce
+### Steps to reproduce
 <!-- Please list the steps required to reproduce the issue, for example: -->
 
-### Important Factoids
+### Important factoids
 <!-- Are there anything atypical about your accounts that we should know? For example: Running in EC2 Classic? Custom version of OpenStack? Tight ACLs?-->
 
 ### References
 <!--Are there any other GitHub issues (open or closed) or Pull Requests that should be linked here? For example:
 - GH-1234
 -->
 
-### Community Note
+### Community note
 <!--- Please keep this note for the community --->
-* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
-* If you are interested in working on this issue or have submitted a pull request, please leave a comment
+* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers rank this request
+* If you interested in working on this issue or have submitted a pull request, please leave a comment

.github/ISSUE_TEMPLATE/feature_request.md

@@ -11,7 +11,7 @@ labels: enhancement
 
 <!--- Please leave a helpful description of the feature request here. --->
 
-### Potential Configuration
+### Potential configuration
 
 <!--- Information about code formatting: https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code --->
 
@@ -29,9 +29,9 @@ Are there any other GitHub issues (open or closed) or pull requests that should
 
 <!--- Please keep this note for the community --->
 
-### Community Note
+### Community note
 
-* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
-* If you are interested in working on this issue or have submitted a pull request, please leave a comment
+* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers rank this request
+* If you interested in working on this issue or have submitted a pull request, please leave a comment
 
 <!--- Thank you for keeping this note for the community --->

.github/styles/Vocab/technical/accept.txt

@@ -0,0 +1,6 @@
+Ansible
+asdf
+mkdocs
+Probot
+probot
+zsh

.github/workflows/automerge.yaml

@@ -19,6 +19,6 @@ on:
 
 jobs:
   automerge:
-    uses: nolte/gh-plumbing/.github/workflows/reuseable-automerge.yaml@develop
+    uses: nolte/gh-plumbing/.github/workflows/reusable-automerge.yaml@develop
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/build-static-tests.yaml

@@ -3,10 +3,10 @@ on:
 
 jobs:
   static:
-    uses: nolte/gh-plumbing/.github/workflows/reuseable-pre-commit.yaml@develop
+    uses: nolte/gh-plumbing/.github/workflows/reusable-pre-commit.yaml@develop
   security:
-    uses: nolte/gh-plumbing/.github/workflows/reuseable-trivy.yaml@develop
+    uses: nolte/gh-plumbing/.github/workflows/reusable-trivy.yaml@develop
   chain-bench:
-    uses: nolte/gh-plumbing/.github/workflows/reuseable-chain-bench.yaml@develop
+    uses: nolte/gh-plumbing/.github/workflows/reusable-chain-bench.yaml@develop
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/dependency-review.yaml

@@ -8,4 +8,4 @@ permissions:
 
 jobs:
   dependency-review:
-    uses: nolte/gh-plumbing/.github/workflows/reuseable-dependency-review.yaml@develop
+    uses: nolte/gh-plumbing/.github/workflows/reusable-dependency-review.yaml@develop

.github/workflows/release-cd-deliver-docs.yml

@@ -4,6 +4,6 @@ on:
 
 jobs:
   publish_docs:
-    uses: nolte/gh-plumbing/.github/workflows/reuseable-mkdocs.yaml@develop
+    uses: nolte/gh-plumbing/.github/workflows/reusable-mkdocs.yaml@develop
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-cd-refresh-master.yml

@@ -4,6 +4,21 @@ on:
 
 jobs:
   refresh_presentation_branch:
-    uses: nolte/gh-plumbing/.github/workflows/reuseable-release-cd-refresh-master.yml@develop
+    uses: nolte/gh-plumbing/.github/workflows/reusable-release-cd-refresh-master.yml@develop
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}
+
+  archive:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: vimtor/action-zip@v1.1
+      with:
+        files: .github/styles/ .vale.ini
+        dest: result.zip
+
+    - name: Upload Release
+      uses: ncipollo/release-action@v1.12.0
+      with:
+          artifacts: "vale-styles.zip"
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-drafter.yml

@@ -6,6 +6,6 @@ on:
 
 jobs:
   update_release_draft:
-    uses: nolte/gh-plumbing/.github/workflows/reuseable-release-drafter.yml@develop
+    uses: nolte/gh-plumbing/.github/workflows/reusable-release-drafter.yml@develop
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/stale.yaml

@@ -4,6 +4,6 @@ on:
 
 jobs:
   stale:
-    uses: nolte/gh-plumbing/.github/workflows/reuseable-stale.yaml@develop
+    uses: nolte/gh-plumbing/.github/workflows/reusable-stale.yaml@develop
     secrets:
       token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1 +1,2 @@
 site
+.github/styles/Microsoft

.vale.ini

@@ -0,0 +1,19 @@
+StylesPath = ".github/styles"
+MinAlertLevel = suggestion
+
+Vocab = "technical"
+
+Packages = Microsoft
+
+IgnoredScopes = code,tt, em
+
+
+[*.md]
+BasedOnStyles = Vale, Microsoft
+
+TokenIgnores = \(\/.*?\), \
+               {%.*?%}, \
+               {{.*?}}, \
+               (.|\/|-)?github(\/|-)?, \
+               (<http[^\n]+>+?)
+

README.md

@@ -1,69 +1,70 @@
 # Plumbing
 
-[![Github Project Stars](https://img.shields.io/github/stars/nolte/gh-plumbing.svg?label=Stars&style=social)](https://github.com/nolte/gh-plumbing) [![Github Issue Tracking](https://img.shields.io/github/issues-raw/nolte/gh-plumbing.svg)](https://github.com/nolte/gh-plumbing) [![Github LatestRelease](https://img.shields.io/github/release/nolte/gh-plumbing.svg)](https://github.com/nolte/gh-plumbing) [![.github/workflows/build-static-tests.yaml](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml) [![.github/workflows/release-cd-deliver-docs.yml](https://github.com/nolte/gh-plumbing/actions/workflows/release-cd-deliver-docs.yml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/release-cd-deliver-docs.yml)
+[![GitHub Project Stars](https://img.shields.io/github/stars/nolte/gh-plumbing.svg?label=Stars&style=social)](https://github.com/nolte/gh-plumbing) [![GitHub Issue Tracking](https://img.shields.io/github/issues-raw/nolte/gh-plumbing.svg)](https://github.com/nolte/gh-plumbing) [![GitHub LatestRelease](https://img.shields.io/github/release/nolte/gh-plumbing.svg)](https://github.com/nolte/gh-plumbing) [![.github/workflows/build-static-tests.yaml](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml) [![.github/workflows/release-cd-deliver-docs.yml](https://github.com/nolte/gh-plumbing/actions/workflows/release-cd-deliver-docs.yml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/release-cd-deliver-docs.yml)
 
 ---
 
 <!--intro-start-->
-Used for deduplicate the CI/CD Boilerplate-Code. Like [Workflow](https://docs.github.com/en/actions) and [Github App](https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps) configurations.
+Used for minimize duplicate the CI/CD Boilerplate-Code. Like [Workflows (GitHub Actions)](https://docs.github.com/en/actions) and [GitHub App](https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps) configurations.
 <!--intro-end-->
 
 ## Workflows
 
 <!--td-workflows-start-->
 | Workflow                                      | description                                                                                                                                                      |
 |-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| ```reuseable-ansible-galaxy-push.yaml```      | Using [robertdebock/galaxy-action](https://github.com/robertdebock/galaxy-action) for publish a Ansible Role to [Ansible Galxy](https://galaxy.ansible.com/).    |
-| ```reuseable-ansible-molecule.yaml```         | Start a simple Molecule test run by using the [gofrolist/molecule-action](https://github.com/gofrolist/molecule-action) action.                                  |
-| ```reuseable-automerge.yaml```                | Using [pascalgn/automerge-action](https://github.com/pascalgn/automerge-action) for better Merge Request handling.                                               |
-| ```reuseable-mkdocs.yaml```                   | Publish a [mkdocs](https://www.mkdocs.org/) based Documentation as [Github Page](https://pages.github.com/).                                                     |
-| ```reuseable-pre-commit.yaml```               | Call [pre-commit](https://pre-commit.com/) for a minimal static tests set, like liter etc.                                                                       |
-| ```reuseable-release-cd-refresh-master.yml``` | Refresh the current master branch, with the Revision from the Latest published Release, so the master/main branch will be present the `latest` Released version. |
-| ```reuseable-release-drafter.yml```           | Will be use [release-drafter/release-drafter](https://github.com/release-drafter/release-drafter) for updating the current "Draft" Release with a Changelog.     |
-| ```reuseable-sphinx.yaml```                   | Build and Publish a [Sphinx](https://www.sphinx-doc.org/en/master) Documentation as [Github Page](https://pages.github.com/).                                    |
-| ```reuseable-stale.yaml```                    | Mark old or inactive issues and close then, used [actions/stale](https://github.com/actions/stale) for this work.                                                |
-| ```reuseable-trivy.yaml```                    | Scan the GitRepo by using [aquasecurity/trivy-action](https://github.com/aquasecurity/trivy-action).                                                             |
-| ```reuseable-tf-lint.yaml```                  | Use [terraform-linters/setup-tflint](https://github.com/terraform-linters/setup-tflint) for Lint terraform sources.                                              |
+| ```reusable-ansible-galaxy-push.yaml```      | Using [robertdebock/galaxy-action](https://github.com/robertdebock/galaxy-action) for publish a Ansible Role to [Ansible Galxy](https://galaxy.ansible.com/).    |
+| ```reusable-ansible-molecule.yaml```         | Start a simple Molecule test run by using the [gofrolist/molecule-action](https://github.com/gofrolist/molecule-action) action.                                  |
+| ```reusable-automerge.yaml```                | Using [pascalgn/automerge-action](https://github.com/pascalgn/automerge-action) for better Merge Request handling.                                               |
+| ```reusable-mkdocs.yaml```                   | Publish a [mkdocs](https://www.mkdocs.org/) based Documentation as [GitHub Page](https://pages.github.com/).                                                     |
+| ```reusable-pre-commit.yaml```               | Call [pre-commit](https://pre-commit.com/) for a minimal static tests set, like liter etc.                                                                       |
+| ```reusable-release-cd-refresh-master.yml``` | Refresh the current master branch, with the Revision from the Latest published Release, so the master/main branch will be present the `latest` Released version. |
+| ```reusable-release-drafter.yml```           | Will be use [release-drafter/release-drafter](https://github.com/release-drafter/release-drafter) for updating the current "Draft" Release with a Changelog.     |
+| ```reusable-sphinx.yaml```                   | Build and Publish a [Sphinx](https://www.sphinx-doc.org/en/master) Documentation as [GitHub Page](https://pages.github.com/).                                    |
+| ```reusable-stale.yaml```                    | Mark old or inactive issues and close then, used [actions/stale](https://github.com/actions/stale) for this work.                                                |
+| ```reusable-trivy.yaml```                    | Scan the GitRepo by using [aquasecurity/trivy-action](https://github.com/aquasecurity/trivy-action).                                                             |
+| ```reusable-tf-lint.yaml```                  | Use [terraform-linters/setup-tflint](https://github.com/terraform-linters/setup-tflint) for Lint terraform sources.                                              |
+
 <!--td-workflows-end-->
 
-## Probot Config
+
+## Probot configuration
 
 <!--probot-intro-start-->
-Collection of common Configs for Project Management and CI/CD.  
-For Using in other Github Projects, having a reuseable set of Probot Config Repo, more informations at [probot.github.io](https://probot.github.io/docs/best-practices/#configuration).
+Collection of common Configurations for Project Management and CI/CD.  
+For Using in other GitHub Projects, having a reusable set of Probot Configuration Repository, more information at [probot.github.io](https://probot.github.io/docs/best-practices/#configuration).
 <!--probot-intro-end-->
 
 <!--td-probot-apps-start-->
 | probot                                                            | git                                                                         | description                                                                                                         |
 |-------------------------------------------------------------------|-----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
-| [boring-cyborg](https://probot.github.io/apps/boring-cyborg/)     | [kaxil/boring-cyborg](https://github.com/kaxil/boring-cyborg)               | Different util actions like, automatically label Pull Request                                                       |
+| [boring-cyborg](https://probot.github.io/apps/boring-cyborg/)     | [kaxil/boring-cyborg](https://github.com/kaxil/boring-cyborg)               | Different actions like, automatically label Pull Request                                                       |
 | [release-drafter](https://probot.github.io/apps/release-drafter/) | [toolmantim/release-drafter](https://github.com/toolmantim/release-drafter) | Creates a Human Readable Release Change Log (**(deprecated)**, please use the Workflow Implementation).             |
 | [renovate](https://github.com/apps/renovate)                      |                                                                             | Using [renovate](https://www.whitesourcesoftware.com/free-developer-tools/renovate/) for keep dependencies in sync. |
-| [settings](https://probot.github.io/apps/settings/)               | [probot/settings](https://github.com/probot/settings)                       | Configure Github Projects by Source.                                                                                |
+| [settings](https://probot.github.io/apps/settings/)               | [probot/settings](https://github.com/probot/settings)                       | Configure GitHub Projects by Source.                                                                                |
 <!--td-probot-apps-end-->
 
-For More Inforation take a look to the GH Page, [gh-plumbing](http://nolte.github.io/gh-plumbing).
+For More information take a look to the GH Page, [gh-plumbing](http://nolte.github.io/gh-plumbing).
 
 ## Development
 
 <!--development-intro-start-->
-We use the [asdf](https://asdf-vm.com/) Packagemanager.
+Use the [asdf](https://asdf-vm.com/) package manager.
 
 ```sh
 asdf install
 ```
 
-### Worflows
+### Workflows
 
 For local testing you can use [nektos/act](https://github.com/nektos/act), run the GitHub Actions locally.
 
 ```sh
-act --job=static
+act push -j static -W .github/workflows/build-static-tests.yaml
 ```
 
-will be start the [![.github/workflows/build-static-tests.yaml](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml) at your local system.
+Will be start the [![.github/workflows/build-static-tests.yaml](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml/badge.svg)](https://github.com/nolte/gh-plumbing/actions/workflows/build-static-tests.yaml) at your system.
 
-**For the Moment blocked by [#826](https://github.com/nektos/act/issues/826)**.
 
 ### Documentation
 
@@ -76,12 +77,12 @@ pip install -r requirements-dev.txt
 mkdocs serve -a localhost:8001
 ```
 
-Open [localhost:8001](http://localhost:8001/) for take a look to the lastest documentation, created with [mkdocs](https://www.mkdocs.org/).
+Open [localhost:8001](http://localhost:8001/) for take a look to the latest documentation, created with [mkdocs](https://www.mkdocs.org/).
 <!--development-intro-end-->
 
 ### Task
 
-We use [go-task/task](https://github.com/go-task/task) as alias tooling.
+Use [go-task/task](https://github.com/go-task/task) as pre-configured command sets.
 
 ```sh
 task -l  

Taskfile.yml

@@ -3,7 +3,10 @@
 version: '3'
 
 vars:
-  PYTHON_VENVS_BASEDIR: ~/.vens/
+  PYTHON_VENVS_BASEDIR: ~/.venvs/
+
+  PYTHON_BIN: python3
+  VENVS: .venvs/
 
 includes:
   py-dev: ./taskfiles/py-venv-dev.yaml
@@ -18,7 +21,8 @@ tasks:
 
   mkdocs:
     desc: Start the Mkdocs, for development
-    deps: ["py-dev:venv-usage"]
+    #deps: ["py-dev:venv-usage"]
     cmds:
-      - mkdocs serve -a localhost:8001
-    silent: true
+        - task: py-dev:venv-usage
+      #- mkdocs serve -a localhost:8001
+    silent: false

docs/index.md

@@ -1,4 +1,4 @@
-# Shared Configs
+# Shared configurations
 
 {%
    include-markdown "../README.md"