From 50ba60f078559be0b02de1bcb063e5b5360f5b58 Mon Sep 17 00:00:00 2001 From: Daniel Mieg <56156797+DanielMieg@users.noreply.github.com> Date: Wed, 27 Jan 2021 18:24:21 +0100 Subject: [PATCH] Docu improvements (#2547) * Add line breaks * Introduce line breaks --- .../docs/pipelines/abapEnvironment/configuration.md | 9 +++++++-- .../docs/pipelines/abapEnvironment/introduction.md | 9 +++++++-- .../abapEnvironment/stages/cloneRepositories.md | 9 +++++++-- documentation/docs/scenarios/abapEnvironmentAddons.md | 9 +++++++-- documentation/docs/scenarios/abapEnvironmentTest.md | 9 +++++++-- 5 files changed, 35 insertions(+), 10 deletions(-) diff --git a/documentation/docs/pipelines/abapEnvironment/configuration.md b/documentation/docs/pipelines/abapEnvironment/configuration.md index 18e6038fe..71e190dc1 100644 --- a/documentation/docs/pipelines/abapEnvironment/configuration.md +++ b/documentation/docs/pipelines/abapEnvironment/configuration.md @@ -19,12 +19,17 @@ You can have a look at different pipeline configurations in our [SAP-samples rep | [Post](stages/post.md) | [cloudFoundryDeleteService](https://sap.github.io/jenkins-library/steps/cloudFoundryDeleteService/)| !!! caution "Upcoming 2102 release of SAP BTP ABAP Environment" + With the upcoming 2102 release of SAP BTP ABAP Environment some changes to the backend behavior of the MANAGE_GIT_REPOSITORY service are introduced. Specifically: - - To pull a software component to a system, the software component needs to be cloned first. - - It is planned to add the possibility to clone a software component repeatedly with the hotfix collection HFC03 of release 2102 + + - To pull a software component to a system, the software component needs to be cloned first. + - It is planned to add the possibility to clone a software component repeatedly with the hotfix collection HFC03 of release 2102 + **Implications for the “abapEnvironmentPipeline”:** + If you are using the “Prepare System” stage to create a new ABAP Environment system, it is no longer possible to use the “Clone Repositories” stage with the “Pull” strategy or with the default strategy (no strategy specified). Please use the strategy “Clone” instead. For more information, have a look at the [stage documentation](./stages/cloneRepositories.md). The strategy “AddonBuild” will execute the abapEnvironmentCloneGitRepo instead of the previous logic. No configuration changes should be necessary. + Please be aware that a repeated execution of a pipeline using the strategy “Clone” or “AddonBuild” will not be possible until hotfix collection HFC03 (planned). The recommended workaround is to replace the strategy “AddonBuild” with “CheckoutPull”, whenever the system from a previous pipeline run is reused. diff --git a/documentation/docs/pipelines/abapEnvironment/introduction.md b/documentation/docs/pipelines/abapEnvironment/introduction.md index ad7b974ba..748050461 100644 --- a/documentation/docs/pipelines/abapEnvironment/introduction.md +++ b/documentation/docs/pipelines/abapEnvironment/introduction.md @@ -6,12 +6,17 @@ The goal of the ABAP Environment Pipeline is to enable Continuous Integration fo The pipeline contains several stages and supports different scenarios. The general idea is that the user can choose a subset of these stages, which fits her/his use case, for example running nightly ATC checks or building an ABAP Add-on for Steampunk. !!! caution "Upcoming 2102 release of SAP BTP ABAP Environment" + With the upcoming 2102 release of SAP BTP ABAP Environment some changes to the backend behavior of the MANAGE_GIT_REPOSITORY service are introduced. Specifically: - - To pull a software component to a system, the software component needs to be cloned first. - - It is planned to add the possibility to clone a software component repeatedly with the hotfix collection HFC03 of release 2102 + + - To pull a software component to a system, the software component needs to be cloned first. + - It is planned to add the possibility to clone a software component repeatedly with the hotfix collection HFC03 of release 2102 + **Implications for the “abapEnvironmentPipeline”:** + If you are using the “Prepare System” stage to create a new ABAP Environment system, it is no longer possible to use the “Clone Repositories” stage with the “Pull” strategy or with the default strategy (no strategy specified). Please use the strategy “Clone” instead. For more information, have a look at the [stage documentation](./stages/cloneRepositories.md). The strategy “AddonBuild” will execute the abapEnvironmentCloneGitRepo instead of the previous logic. No configuration changes should be necessary. + Please be aware that a repeated execution of a pipeline using the strategy “Clone” or “AddonBuild” will not be possible until hotfix collection HFC03 (planned). The recommended workaround is to replace the strategy “AddonBuild” with “CheckoutPull”, whenever the system from a previous pipeline run is reused. diff --git a/documentation/docs/pipelines/abapEnvironment/stages/cloneRepositories.md b/documentation/docs/pipelines/abapEnvironment/stages/cloneRepositories.md index babbce277..bf377fb23 100644 --- a/documentation/docs/pipelines/abapEnvironment/stages/cloneRepositories.md +++ b/documentation/docs/pipelines/abapEnvironment/stages/cloneRepositories.md @@ -3,12 +3,17 @@ This stage creates pulls/clones the specified software components (repositories) to the ABAP Environment system. !!! caution "Upcoming 2102 release of SAP BTP ABAP Environment" + With the upcoming 2102 release of SAP BTP ABAP Environment some changes to the backend behavior of the MANAGE_GIT_REPOSITORY service are introduced. Specifically: - - To pull a software component to a system, the software component needs to be cloned first. - - It is planned to add the possibility to clone a software component repeatedly with the hotfix collection HFC03 of release 2102 + + - To pull a software component to a system, the software component needs to be cloned first. + - It is planned to add the possibility to clone a software component repeatedly with the hotfix collection HFC03 of release 2102 + **Implications for the “abapEnvironmentPipeline”:** + If you are using the “Prepare System” stage to create a new ABAP Environment system, it is no longer possible to use the “Clone Repositories” stage with the “Pull” strategy or with the default strategy (no strategy specified). Please use the strategy “Clone” instead. For more information, read the stage documentation below. The strategy “AddonBuild” will execute the abapEnvironmentCloneGitRepo instead of the previous logic. No configuration changes should be necessary. + Please be aware that a repeated execution of a pipeline using the strategy “Clone” or “AddonBuild” will not be possible until hotfix collection HFC03 (planned). The recommended workaround is to replace the strategy “AddonBuild” with “CheckoutPull”, whenever the system from a previous pipeline run is reused. diff --git a/documentation/docs/scenarios/abapEnvironmentAddons.md b/documentation/docs/scenarios/abapEnvironmentAddons.md index c0b724a76..69c895615 100644 --- a/documentation/docs/scenarios/abapEnvironmentAddons.md +++ b/documentation/docs/scenarios/abapEnvironmentAddons.md @@ -7,12 +7,17 @@ You cannot build add-ons based on gCTS branching functionality. !!! caution "Upcoming 2102 release of SAP BTP ABAP Environment" + With the upcoming 2102 release of SAP BTP ABAP Environment some changes to the backend behavior of the MANAGE_GIT_REPOSITORY service are introduced. Specifically: - - To pull a software component to a system, the software component needs to be cloned first. - - It is planned to add the possibility to clone a software component repeatedly with the hotfix collection HFC03 of release 2102 + + - To pull a software component to a system, the software component needs to be cloned first. + - It is planned to add the possibility to clone a software component repeatedly with the hotfix collection HFC03 of release 2102 + **Implications for the “abapEnvironmentPipeline”:** + If you are using the “Prepare System” stage to create a new ABAP Environment system, it is no longer possible to use the “Clone Repositories” stage with the “Pull” strategy or with the default strategy (no strategy specified). Please use the strategy “Clone” instead. For more information, have a look at the [stage documentation](../pipelines/abapEnvironment/stages/cloneRepositories.md). The strategy “AddonBuild” will execute the abapEnvironmentCloneGitRepo instead of the previous logic. No configuration changes should be necessary. + Please be aware that a repeated execution of a pipeline using the strategy “Clone” or “AddonBuild” will not be possible until hotfix collection HFC03 (planned). The recommended workaround is to replace the strategy “AddonBuild” with “CheckoutPull”, whenever the system from a previous pipeline run is reused. diff --git a/documentation/docs/scenarios/abapEnvironmentTest.md b/documentation/docs/scenarios/abapEnvironmentTest.md index 0592ae4e3..c014c7226 100644 --- a/documentation/docs/scenarios/abapEnvironmentTest.md +++ b/documentation/docs/scenarios/abapEnvironmentTest.md @@ -5,12 +5,17 @@ This scenario describes how to test ABAP development for the SAP BTP ABAP Environment (also known as Steampunk). In Steampunk, the development is done within [“software components”](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/58480f43e0b64de782196922bc5f1ca0.html) (also called: “repositories”) and "transported" via git-based approaches. The [ABAP Environment Pipeline](../pipelines/abapEnvironment/introduction.md) is a predefined pipeline, which can be used to import ABAP development into a quality system and execute tests. !!! caution "Upcoming 2102 release of SAP BTP ABAP Environment" + With the upcoming 2102 release of SAP BTP ABAP Environment some changes to the backend behavior of the MANAGE_GIT_REPOSITORY service are introduced. Specifically: - - To pull a software component to a system, the software component needs to be cloned first. - - It is planned to add the possibility to clone a software component repeatedly with the hotfix collection HFC03 of release 2102 + + - To pull a software component to a system, the software component needs to be cloned first. + - It is planned to add the possibility to clone a software component repeatedly with the hotfix collection HFC03 of release 2102 + **Implications for the “abapEnvironmentPipeline”:** + If you are using the “Prepare System” stage to create a new ABAP Environment system, it is no longer possible to use the “Clone Repositories” stage with the “Pull” strategy or with the default strategy (no strategy specified). Please use the strategy “Clone” instead. For more information, have a look at the [stage documentation](../pipelines/abapEnvironment/stages/cloneRepositories.md). The strategy “AddonBuild” will execute the abapEnvironmentCloneGitRepo instead of the previous logic. No configuration changes should be necessary. + Please be aware that a repeated execution of a pipeline using the strategy “Clone” or “AddonBuild” will not be possible until hotfix collection HFC03 (planned). The recommended workaround is to replace the strategy “AddonBuild” with “CheckoutPull”, whenever the system from a previous pipeline run is reused.