docs: add parameter documentation (#53)

This commit is contained in:
Robert Kaussow
2021-09-11 21:15:02 +02:00
committed by GitHub
parent 276f215b24
commit 2404bc12a1
8 changed files with 468 additions and 246 deletions

View File

@@ -235,6 +235,60 @@ local PipelineBuildContainer(arch='amd64') = {
},
};
local PipelineDocs = {
kind: 'pipeline',
name: 'docs',
platform: {
os: 'linux',
arch: 'amd64',
},
concurrency: {
limit: 1,
},
steps: [
{
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/**/*.md' 'README.md' 'CONTRIBUTING.md' -d .dictionary -p spell indefinite-article syntax-urls --no-suggestions",
],
environment: {
FORCE_COLOR: true,
NPM_CONFIG_LOGLEVEL: 'error',
},
},
{
name: 'publish',
image: 'plugins/gh-pages',
settings: {
username: { from_secret: 'github_username' },
password: { from_secret: 'github_token' },
pages_directory: '_docs/',
target_branch: 'docs',
},
when: {
ref: ['refs/heads/main'],
},
},
],
depends_on: [
'build-binaries',
'build-container-amd64',
'build-container-arm64',
],
trigger: {
ref: ['refs/heads/main', 'refs/tags/**', 'refs/pull/**'],
},
};
local PipelineNotifications = {
kind: 'pipeline',
image_pull_secrets: ['docker_config'],
@@ -320,9 +374,7 @@ local PipelineNotifications = {
},
],
depends_on: [
'build-binaries',
'build-container-amd64',
'build-container-arm64',
'docs',
],
trigger: {
ref: ['refs/heads/main', 'refs/tags/**'],
@@ -335,5 +387,6 @@ local PipelineNotifications = {
PipelineBuildBinaries,
PipelineBuildContainer(arch='amd64'),
PipelineBuildContainer(arch='arm64'),
PipelineDocs,
PipelineNotifications,
]