jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00
Code Issues Releases Activity

Remove absolute links from Cloud SDK docs section (#2089)

Browse Source
This commit is contained in:
Kevin Hudemann 2020-09-29 14:23:46 +02:00 committed by GitHub
parent 19c1732826
commit b47e08781c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
documentation/docs/pipelines/cloud-sdk/build-tools.md
View File

@ -55,7 +55,7 @@ For Java, the default is still (as of August 2020) version 8.
For more details, please check the [documentation of the SAP Cloud SDK for Java](https://sap.github.io/cloud-sdk/docs/java/getting-started/).
In case you need to use a specific Java version to build your application, you may do so by setting another Docker image in your `.pipeline/config.yml` file.
See [documentation of the pipeline configuration](https://github.com/SAP/cloud-s4-sdk-pipeline/blob/master/configuration.md) and look for the `dockerImage` key on where this option applies.
See [documentation of the pipeline configuration](../configuration/) and look for the `dockerImage` key on where this option applies.
In most cases, it should be suffcient to configure an image for the `mavenExecute` step like so:
@ -70,7 +70,7 @@ steps:
Each variant of the pipeline has different requirements regarding the project structure, location of reports and tooling.
Stages not listed here do not have a special requirement.
In any case, please also consult the [documentation of the pipeline configuration](https://github.com/SAP/cloud-s4-sdk-pipeline/blob/master/configuration.md), as some stages have to be activated by providing configuration values.
In any case, please also consult the [documentation of the pipeline configuration](../configuration/), as some stages have to be activated by providing configuration values.
### Build Tool Independent Requirements
@ -103,7 +103,7 @@ It is recommended to use the same tools as in the `package.json` of this [exampl
##### Maven
Maven unit-tests are executed as part of the [`mavenBuild`](https://sap.github.io/jenkins-library/steps/mavenBuild/) step.
Maven unit-tests are executed as part of the [`mavenBuild`](../../../steps/mavenBuild/) step.
They are supposed to be placed inside of `application/src/test`.
##### Java MTA modules

2
documentation/docs/pipelines/cloud-sdk/cloud-qualities.md
View File

@ -99,7 +99,7 @@ In addition to the default checks of those tools, it adds the following SAP Clou
The pipeline automatically executes linting of JavaScript and Typescript files, either by running a user defined script, or by executing ESLint with a general purpose configuration.
[Custom linters](https://sap.github.io/jenkins-library/extensibility/#practical-example) can be implemented by development teams, if desired.
[Custom linters](../../../extensibility/#practical-example) can be implemented by development teams, if desired.
This allows to enforce a common coding style within a team of developers, thus making it easier to focus on the application code, rather then discussing minor style issues.

22
documentation/docs/pipelines/cloud-sdk/configuration.md
View File

@ -54,7 +54,7 @@ general:
### staticCodeChecks
The `staticCodeChecks` stage has been integrated into the `build` stage.
To configure static code checks, please configure the step `mavenExecuteStaticCodeChecks` as described [here](https://sap.github.io/jenkins-library/steps/mavenExecuteStaticCodeChecks/).
To configure static code checks, please configure the step `mavenExecuteStaticCodeChecks` as described [here](../../../steps/mavenExecuteStaticCodeChecks/).
### backendIntegrationTests
@ -171,7 +171,7 @@ This stage has been removed in v43 of the Cloud SDK pipeline.
### checkmarxScan
The `checkmarxScan` stage has been merged into the project "Piper" stage `security`.
To configure Checkmarx please configure the step `checkmarxExecuteScan` as described [in the step documentation](https://sap.github.io/jenkins-library/steps/checkmarxExecuteScan/).
To configure Checkmarx please configure the step `checkmarxExecuteScan` as described [in the step documentation](../../../steps/checkmarxExecuteScan/).
### productionDeployment
@ -186,7 +186,7 @@ To configure Checkmarx please configure the step `checkmarxExecuteScan` as descr
The option `cfCreateServices` is especially useful if you don't use MTA and need a way to declaratively define which services should be created in Cloud Foundry.
The following properties can be defined for each element in the list.
For a detailed documentation of the indivitual properties please consult the [step documentation](https://sap.github.io/jenkins-library/steps/cloudFoundryCreateService/).
For a detailed documentation of the indivitual properties please consult the [step documentation](../../../steps/cloudFoundryCreateService/).
| Property | Mandatory | Default Value | Description |
| --- | --- | --- | --- |
@ -350,23 +350,23 @@ artifactDeployment:
### whitesourceScan
The `whitesourceScan` stage has been merged into the project "Piper" stage `security`.
To configure WhiteSource please configure the step `whitesourceExecuteScan` as described [in the step documentation](https://sap.github.io/jenkins-library/steps/whitesourceExecuteScan/).
To configure WhiteSource please configure the step `whitesourceExecuteScan` as described [in the step documentation](../../../steps/whitesourceExecuteScan/).
### fortifyScan
The `fortifyScan` stage has been merged into the project "Piper" stage `security`.
To configure Fortify please configure the step `fortifyExecuteScan` as described [in the step documentation](https://sap.github.io/jenkins-library/steps/fortifyExecuteScan/).
To configure Fortify please configure the step `fortifyExecuteScan` as described [in the step documentation](../../../steps/fortifyExecuteScan/).
### lint
The `lint` stage has been integrated into the `build` stage.
The options for the use of linting tools remain the same and are described in the [build tools section](https://sap.github.io/jenkins-library/pipelines/cloud-sdk/build-tools/#lint).
The options for the use of linting tools remain the same and are described in the [build tools section](../build-tools/#lint).
Note, the available configuration options can be found in the related [step documentation](https://sap.github.io/jenkins-library/steps/npmExecuteLint/#parameters).
Note, the available configuration options can be found in the related [step documentation](../../../steps/npmExecuteLint/#parameters).
### compliance
The stage `compliance` executes [SonarQube](https://www.sonarqube.org/) scans, if the step [`sonarExecuteScan`](https://sap.github.io/jenkins-library/steps/sonarExecuteScan/) is configured.
The stage `compliance` executes [SonarQube](https://www.sonarqube.org/) scans, if the step [`sonarExecuteScan`](../../../steps/sonarExecuteScan/) is configured.
This is an optional feature for teams who prefer to use SonarQube.
Note that it does some scans that are already done by the pipeline by default.
@ -390,7 +390,7 @@ compliance:
This stage does nothing.
Its purpose is to be overridden if required.
See the documentation for [pipeline extensibility](https://sap.github.io/jenkins-library/extensibility/) for details on how to extend a stage.
See the documentation for [pipeline extensibility](../../../extensibility/) for details on how to extend a stage.
The name of an extension file must be `postPipelineHook.groovy`.
Also, the stage (and thus an extension) is only executed if a stage configuration exists, like in this example:
@ -445,11 +445,11 @@ checkJMeter:
### executeNpm
This step has been removed in v43 of the Cloud SDK pipeline.
Please use the step [npmExecuteScripts](https://sap.github.io/jenkins-library/steps/npmExecuteScripts/) instead.
Please use the step [npmExecuteScripts](../../../steps/npmExecuteScripts/) instead.
### debugReportArchive
The documentation for the `debugReportArchive` step has been moved [here](https://sap.github.io/jenkins-library/steps/debugReportArchive/).
The documentation for the `debugReportArchive` step has been moved [here](../../../steps/debugReportArchive/).
## Post action configuration