sap-jenkins-library/documentation/mkdocs.yml

site_name: Jenkins 2.0 Pipelines
pages:
    - Home: index.md
    - 'Library steps':
        - artifactSetVersion: steps/artifactSetVersion.md
        - commonPipelineEnvironment: steps/commonPipelineEnvironment.md
        - dockerExecute: steps/dockerExecute.md
        - durationMeasure: steps/durationMeasure.md
        - handlePipelineStepErrors: steps/handlePipelineStepErrors.md
        - influxWriteData: steps/influxWriteData.md
        - mavenExecute: steps/mavenExecute.md
        - mtaBuild: steps/mtaBuild.md
        - neoDeploy: steps/neoDeploy.md
        - pipelineExecute: steps/pipelineExecute.md
        - pipelineStashFiles: steps/pipelineStashFiles.md
        - prepareDefaultValues: steps/prepareDefaultValues.md
        - setupCommonPipelineEnvironment: steps/setupCommonPipelineEnvironment.md
        - toolValidate: steps/toolValidate.md
    - 'Required Plugins': jenkins/requiredPlugins.md

theme:
    name: 'material'
    palette:
      primary: 'teal'
      accent: 'purple'
    logo: 'images/piper_head_white.png'
    favicon: 'images/favicon.ico'
extra:
    font:
      text: 'Slabo 13px'
      code: 'Ubuntu Mono'
markdown_extensions:
    - admonition
    - codehilite(guess_lang=false)
    - toc(permalink=true)
    - footnotes
    - pymdownx.superfences
extra_css:
    - 'css/extra.css'
edit_uri: edit/master/documentation/docs
docs_dir: docs
site_dir: docs-gen
repo_url: https://github.com/SAP/jenkins-library
Initial version of piper-lib. 2017-07-11 15:12:03 +02:00			`site_name: Jenkins 2.0 Pipelines`
			`pages:`
			`- Home: index.md`
			`- 'Library steps':`
Step for automatic versioning (#65) It contains: * versioning step artifactSetVersion * versioning implementation for Maven & Docker * enhancements to commonPipelineEnvironment * extended default configuration * new utils object for git-related tasks * automated tests incl. new Rules and resources * incorporated PR feedback * step documentation 2018-02-07 14:17:33 +02:00			`- artifactSetVersion: steps/artifactSetVersion.md`
Initial version of piper-lib. 2017-07-11 15:12:03 +02:00			`- commonPipelineEnvironment: steps/commonPipelineEnvironment.md`
InfluxDB support (#52) * adding step for writing metrics to InfluxDB including dependencies * added documentation * incorporated PR feedback 2018-01-24 10:55:38 +02:00			`- dockerExecute: steps/dockerExecute.md`
			`- durationMeasure: steps/durationMeasure.md`
Initial version of piper-lib. 2017-07-11 15:12:03 +02:00			`- handlePipelineStepErrors: steps/handlePipelineStepErrors.md`
InfluxDB support (#52) * adding step for writing metrics to InfluxDB including dependencies * added documentation * incorporated PR feedback 2018-01-24 10:55:38 +02:00			`- influxWriteData: steps/influxWriteData.md`
			`- mavenExecute: steps/mavenExecute.md`
Initial version of piper-lib. 2017-07-11 15:12:03 +02:00			`- mtaBuild: steps/mtaBuild.md`
			`- neoDeploy: steps/neoDeploy.md`
InfluxDB support (#52) * adding step for writing metrics to InfluxDB including dependencies * added documentation * incorporated PR feedback 2018-01-24 10:55:38 +02:00			`- pipelineExecute: steps/pipelineExecute.md`
pipelineStashFiles - cleanup & documentation This contains some cleanups to the code plus documentation for the step 2018-06-01 12:33:06 +02:00			`- pipelineStashFiles: steps/pipelineStashFiles.md`
Enable configuration via yaml file + mavenExecute as example (#18) * Enable configuration via yaml file * Add documentation * Add tests 2017-12-06 13:03:06 +02:00			`- prepareDefaultValues: steps/prepareDefaultValues.md`
InfluxDB support (#52) * adding step for writing metrics to InfluxDB including dependencies * added documentation * incorporated PR feedback 2018-01-24 10:55:38 +02:00			`- setupCommonPipelineEnvironment: steps/setupCommonPipelineEnvironment.md`
			`- toolValidate: steps/toolValidate.md`
Initial version of piper-lib. 2017-07-11 15:12:03 +02:00			`- 'Required Plugins': jenkins/requiredPlugins.md`

Enable configuration via yaml file + mavenExecute as example (#18) * Enable configuration via yaml file * Add documentation * Add tests 2017-12-06 13:03:06 +02:00			`theme:`
Update mkdocs.yml to MkDocs 0.17.0 format MkDocs 0.17 features theme customization options [1] which are picked up supported with mkdocs-material 2.0.1 [2] and later. These are now the minimum required versions to compile our gh-pages documentation. [1] http://www.mkdocs.org/about/release-notes/#major-additions-to-version-0170 [2] https://github.com/squidfunk/mkdocs-material/releases/tag/2.0.0 2017-11-17 16:33:08 +02:00			`name: 'material'`
Initial version of piper-lib. 2017-07-11 15:12:03 +02:00			`palette:`
			`primary: 'teal'`
			`accent: 'purple'`
Update mkdocs.yml to MkDocs 0.17.0 format MkDocs 0.17 features theme customization options [1] which are picked up supported with mkdocs-material 2.0.1 [2] and later. These are now the minimum required versions to compile our gh-pages documentation. [1] http://www.mkdocs.org/about/release-notes/#major-additions-to-version-0170 [2] https://github.com/squidfunk/mkdocs-material/releases/tag/2.0.0 2017-11-17 16:33:08 +02:00			`logo: 'images/piper_head_white.png'`
			`favicon: 'images/favicon.ico'`
			`extra:`
Initial version of piper-lib. 2017-07-11 15:12:03 +02:00			`font:`
			`text: 'Slabo 13px'`
			`code: 'Ubuntu Mono'`
			`markdown_extensions:`
			`- admonition`
			`- codehilite(guess_lang=false)`
			`- toc(permalink=true)`
			`- footnotes`
			`- pymdownx.superfences`
Enable configuration via yaml file + mavenExecute as example (#18) * Enable configuration via yaml file * Add documentation * Add tests 2017-12-06 13:03:06 +02:00			`extra_css:`
Initial version of piper-lib. 2017-07-11 15:12:03 +02:00			`- 'css/extra.css'`
			`edit_uri: edit/master/documentation/docs`
			`docs_dir: docs`
			`site_dir: docs-gen`
			`repo_url: https://github.com/SAP/jenkins-library`