From 5fc8dcb13cc55c2772c5e658f8f9d2ec3500e1d5 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Sat, 11 Sep 2021 13:06:33 +0200 Subject: [PATCH] initial commit --- .batchfile | 1 + .dictionary | 0 .drone.jsonnet | 107 +++++++++++++++++++++++++++++++++++++++++++ .drone.yml | 80 ++++++++++++++++++++++++++++++++ .github/settings.yml | 55 ++++++++++++++++++++++ .gitignore | 4 ++ .markdownlint.yml | 6 +++ CONTRIBUTING.md | 31 +++++++++++++ LICENSE | 20 ++++++++ Makefile | 20 ++++++++ README.md | 3 ++ config.yaml | 31 +++++++++++++ content/_index.md | 10 ++++ renovate.json | 4 ++ static/.htaccess | 16 +++++++ 15 files changed, 388 insertions(+) create mode 100644 .batchfile create mode 100644 .dictionary create mode 100644 .drone.jsonnet create mode 100644 .drone.yml create mode 100644 .github/settings.yml create mode 100644 .gitignore create mode 100644 .markdownlint.yml create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 config.yaml create mode 100644 content/_index.md create mode 100644 renovate.json create mode 100644 static/.htaccess diff --git a/.batchfile b/.batchfile new file mode 100644 index 0000000..40d39eb --- /dev/null +++ b/.batchfile @@ -0,0 +1 @@ +https://github.com/thegeeklab/drone-docker;docs;content/plugins/drone-docker diff --git a/.dictionary b/.dictionary new file mode 100644 index 0000000..e69de29 diff --git a/.drone.jsonnet b/.drone.jsonnet new file mode 100644 index 0000000..87fad41 --- /dev/null +++ b/.drone.jsonnet @@ -0,0 +1,107 @@ +local PipelineDocs = { + kind: 'pipeline', + name: 'docs', + platform: { + os: 'linux', + arch: 'amd64', + }, + concurrency: { + limit: 1, + }, + steps: [ + { + name: 'assets', + image: 'thegeeklab/alpine-tools', + commands: [ + 'make doc', + ], + }, + { + name: 'sync', + image: 'thegeeklab/git-batch', + commands: [ + 'git-batch', + ], + }, + { + name: 'markdownlint', + image: 'thegeeklab/markdownlint-cli', + commands: [ + "markdownlint 'docs/content/**/*.md' 'README.md' 'CONTRIBUTING.md'", + ], + }, + { + name: 'spellcheck', + image: 'node:lts-alpine', + commands: [ + 'npm install -g spellchecker-cli', + "spellchecker --files 'docs/content/**/*.md' 'README.md' -d .dictionary -p spell indefinite-article syntax-urls --no-suggestions", + ], + environment: { + FORCE_COLOR: true, + NPM_CONFIG_LOGLEVEL: 'error', + }, + }, + { + name: 'testbuild', + image: 'thegeeklab/hugo:0.83.1', + commands: [ + 'hugo -s docs/ -b http://localhost/', + ], + }, + { + name: 'link-validation', + image: 'thegeeklab/link-validator', + commands: [ + 'link-validator -ro', + ], + environment: { + LINK_VALIDATOR_BASE_DIR: 'docs/public', + }, + }, + { + name: 'build', + image: 'thegeeklab/hugo:0.83.1', + commands: [ + 'hugo -s docs/', + ], + }, + { + name: 'beautify', + image: 'node:lts-alpine', + commands: [ + 'npm install -g js-beautify', + "html-beautify -r -f 'docs/public/**/*.html'", + ], + environment: { + FORCE_COLOR: true, + NPM_CONFIG_LOGLEVEL: 'error', + }, + }, + { + name: 'publish', + image: 'plugins/s3-sync', + settings: { + access_key: { from_secret: 's3_access_key' }, + bucket: 'geekdocs', + delete: true, + endpoint: 'https://sp.rknet.org', + path_style: true, + secret_key: { from_secret: 's3_secret_access_key' }, + source: 'docs/public/', + strip_prefix: 'docs/public/', + target: '/${DRONE_REPO_NAME}', + }, + when: { + ref: ['refs/heads/main', 'refs/tags/**'], + }, + }, + ], + trigger: { + ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'], + }, +}; + +[ + PipelineDocs, +] diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000..62ae085 --- /dev/null +++ b/.drone.yml @@ -0,0 +1,80 @@ +--- +concurrency: + limit: 1 +kind: pipeline +name: docs +platform: + arch: amd64 + os: linux +steps: +- commands: + - make doc + image: thegeeklab/alpine-tools + name: assets +- commands: + - git-batch + image: thegeeklab/git-batch + name: sync +- commands: + - markdownlint 'docs/content/**/*.md' 'README.md' 'CONTRIBUTING.md' + image: thegeeklab/markdownlint-cli + name: markdownlint +- commands: + - npm install -g spellchecker-cli + - spellchecker --files 'docs/content/**/*.md' 'README.md' -d .dictionary -p spell + indefinite-article syntax-urls --no-suggestions + environment: + FORCE_COLOR: true + NPM_CONFIG_LOGLEVEL: error + image: node:lts-alpine + name: spellcheck +- commands: + - hugo -s docs/ -b http://localhost/ + image: thegeeklab/hugo:0.83.1 + name: testbuild +- commands: + - link-validator -ro + environment: + LINK_VALIDATOR_BASE_DIR: docs/public + image: thegeeklab/link-validator + name: link-validation +- commands: + - hugo -s docs/ + image: thegeeklab/hugo:0.83.1 + name: build +- commands: + - npm install -g js-beautify + - html-beautify -r -f 'docs/public/**/*.html' + environment: + FORCE_COLOR: true + NPM_CONFIG_LOGLEVEL: error + image: node:lts-alpine + name: beautify +- image: plugins/s3-sync + name: publish + settings: + access_key: + from_secret: s3_access_key + bucket: geekdocs + delete: true + endpoint: https://sp.rknet.org + path_style: true + secret_key: + from_secret: s3_secret_access_key + source: docs/public/ + strip_prefix: docs/public/ + target: /${DRONE_REPO_NAME} + when: + ref: + - refs/heads/main + - refs/tags/** +trigger: + ref: + - refs/heads/main + - refs/tags/** + - refs/pull/** +--- +kind: signature +hmac: ade2128e9bd2cdac2df077a5832d803252234bd4b9c50a1dcaaed1f94f1d1dee + +... diff --git a/.github/settings.yml b/.github/settings.yml new file mode 100644 index 0000000..759d4b6 --- /dev/null +++ b/.github/settings.yml @@ -0,0 +1,55 @@ +repository: + name: drone-plugin-index + description: Drone custom plugin index + topics: drone, drone-plugin + + private: false + has_issues: true + has_wiki: false + has_downloads: true + + default_branch: main + + allow_squash_merge: true + allow_merge_commit: true + allow_rebase_merge: true + +labels: + - name: bug + color: d73a4a + description: Something isn't working + - name: documentation + color: 0075ca + description: Improvements or additions to documentation + - name: duplicate + color: cfd3d7 + description: This issue or pull request already exists + - name: enhancement + color: a2eeef + description: New feature or request + - name: good first issue + color: 7057ff + description: Good for newcomers + - name: help wanted + color: 008672 + description: Extra attention is needed + - name: invalid + color: e4e669 + description: This doesn't seem right + - name: question + color: d876e3 + description: Further information is requested + - name: wontfix + color: ffffff + description: This will not be worked on + +branches: + - name: main + protection: + required_pull_request_reviews: null + required_status_checks: + strict: false + contexts: + - continuous-integration/drone/pr + enforce_admins: null + restrictions: null diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6098772 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +public/ +resources/_gen/ +themes/ +content/**/ diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 0000000..b59a114 --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,6 @@ +--- +default: True +MD013: False +MD041: False +MD004: + style: dash diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c471f59 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +## Security + +If you think you have found a **security issue**, please do not mention it in this repository. +Instead, send an email to security@thegeeklab.de with as many details as possible so it can be handled confidential. + +## Bug Reports and Feature Requests + +If you have found a **bug** or have a **feature request** please use the search first in case a similar issue already exists. +If not, please create an issue in this repository + +## Code + +If you would like to fix a bug or implement a feature, please fork the repository and create a Pull Request. + +Before you start any Pull Request, it is recommended that you create an issue to discuss first if you have any +doubts about requirement or implementation. That way you can be sure that the maintainer(s) agree on what to change and how, +and you can hopefully get a quick merge afterwards. + +Pull Requests can only be merged once all status checks are green. + +## Do not force push to your Pull Request branch + +Please do not force push to your Pull Requests branch after you have created your Pull Request, as doing so makes it harder for us to review your work. +Pull Requests will always be squashed by us when we merge your work. Commit as many times as you need in your Pull Request branch. + +## Re-requesting a review + +Please do not ping your reviewer(s) by mentioning them in a new comment. Instead, use the re-request review functionality. +Read more about this in the [GitHub docs, Re-requesting a review](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request#re-requesting-a-review). diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5fd32c5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2021 Robert Kaussow + +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. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..811f548 --- /dev/null +++ b/Makefile @@ -0,0 +1,20 @@ +# renovate: datasource=github-releases depName=thegeeklab/hugo-geekdoc +THEME_VERSION := v0.15.0 +THEME := hugo-geekdoc +BASEDIR := . +THEMEDIR := $(BASEDIR)/themes + +.PHONY: all +all: doc + +.PHONY: doc +doc: doc-assets + +.PHONY: doc-assets +doc-assets: + mkdir -p $(THEMEDIR)/$(THEME)/ ; \ + curl -sSL "https://github.com/thegeeklab/$(THEME)/releases/download/${THEME_VERSION}/$(THEME).tar.gz" | tar -xz -C $(THEMEDIR)/$(THEME)/ --strip-components=1 + +.PHONY: clean +clean: + rm -rf $(THEMEDIR) && \ diff --git a/README.md b/README.md new file mode 100644 index 0000000..77600ed --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# drone-plugin-index + +Drone CI custom resource documentation. diff --git a/config.yaml b/config.yaml new file mode 100644 index 0000000..2064f7f --- /dev/null +++ b/config.yaml @@ -0,0 +1,31 @@ +--- +baseURL: https://drone-plugins.geekdocs.de/ +title: Drone CI Plugins +theme: hugo-geekdoc + +# Required to get well formatted code blocks +pygmentsUseClasses: true +pygmentsCodeFences: true + +disablePathToLower: true +enableGitInfo: true + +markup: + goldmark: + # Needed for mermaid shortcode + renderer: + unsafe: true + tableOfContents: + startLevel: 1 + endLevel: 9 + +params: + geekdocToC: 3 + + geekdocDateFormat: "Jan 2, 2006" + geekdocSearch: true + + geekdocAnchorLeft: true + + geekdocLegalNotice: https://thegeeklab.de/legal-notice/#contact-information + geekdocPrivacyPolicy: https://thegeeklab.de/legal-notice/#privacy-policy diff --git a/content/_index.md b/content/_index.md new file mode 100644 index 0000000..000f68f --- /dev/null +++ b/content/_index.md @@ -0,0 +1,10 @@ +--- +title: Documentation +--- + +{{< hint warning >}} +**Warning**\ +You should not trust any Docker resource on the internet without verification! Use it at your own risk. +{{< /hint >}} + +This project provides documentation custom Drone CI plugins maintained by us. diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..bf73d46 --- /dev/null +++ b/renovate.json @@ -0,0 +1,4 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": ["github>thegeeklab/renovate-presets"] +} diff --git a/static/.htaccess b/static/.htaccess new file mode 100644 index 0000000..b5a07f4 --- /dev/null +++ b/static/.htaccess @@ -0,0 +1,16 @@ +ErrorDocument 404 /404.html + +ExpiresActive On +ExpiresDefault "access plus 600 seconds" +ExpiresByType text/css "access plus 1 week" +ExpiresByType text/javascript "access plus 1 month" +ExpiresByType text/html "access plus 1 seconds" +ExpiresByType application/javascript "access plus 1 month" +ExpiresByType application/x-javascript "access plus 1 month" +ExpiresByType image/gif "access plus 1 week" +ExpiresByType image/jpeg "access plus 1 week" +ExpiresByType image/png "access plus 1 week" +ExpiresByType image/x-icon "access plus 1 month" +ExpiresByType image/svg+xml "access plus 1 week" +ExpiresByType application/x-font-woff "access plus 1 week" +ExpiresByType application/font-woff2 "access plus 1 week"