From 97dde3311732e4ba3a95319f420346ab6b4e4e9f Mon Sep 17 00:00:00 2001 From: Marc Bernard <59966492+mbtools@users.noreply.github.com> Date: Tue, 16 Apr 2024 09:50:00 +0200 Subject: [PATCH] Clarify community vs SAP version (#228) --- src/README.md | 17 +++++------------ src/user-guide/getting-started/install.md | 4 ++++ 2 files changed, 9 insertions(+), 12 deletions(-) diff --git a/src/README.md b/src/README.md index b453190b9..e6161586c 100644 --- a/src/README.md +++ b/src/README.md @@ -22,22 +22,15 @@ abapGit is a git client for ABAP developed in ABAP. It requires ABAP version 702 Latest build: zabapgit_standalone.prog.abap -For questions/comments/bugs/feature requests/wishes please create an [issue](https://github.com/abapGit/abapGit/issues). +For questions, comments, bugs, feature requests, or other wishes please create an [issue](https://github.com/abapGit/abapGit/issues). ## Security -abapGit is a tool to import and export code between ABAP systems. If a developer has a developer key to the system, -the developer can perform these actions already. abapGit enables the developer to do mass export/changes/imports but -not more than already possible to do manually. +abapGit is a tool to import and export code between ABAP systems. If a developer has a developer key to the system, the developer can perform these actions already. abapGit enables the developer to do mass export/changes/imports but not more than already possible to do manually. -Running automated security checks on the abapGit code will by design give a lot of errors, as abapGit will import, overwrite and change -ABAP artifacts in the system in ways that might not be intended. Always review all code in remote repositories before importing to the target system, -this is possible because abapGit is plain text unlike traditional transport files. +Running automated security checks on the abapGit code will by design give a lot of errors, as abapGit will import, overwrite and change ABAP artifacts in the system in ways that might not be intended. Always review all code in remote repositories before importing to the target system, this is possible because abapGit is plain text unlike traditional transport files. -That being said, abapGit is used by multiple [organizations](/user-guide/other/where-used.md), all abapGit -changes are reviewed via pull requests. And all 100+ [repository watchers](https://github.com/abapGit/abapGit/watchers) are -automatically notified for every change to the code base, so potentially all changes are looked at by more people than -traditional enterprise products. +That being said, abapGit is used by multiple [organizations](/user-guide/other/where-used.md), all abapGit changes are reviewed via pull requests. And all 100+ [repository watchers](https://github.com/abapGit/abapGit/watchers) are automatically notified for every change to the code base, so potentially all changes are looked at by more people than traditional enterprise products. ## Support @@ -47,4 +40,4 @@ It is a community effort to support the project, recommend [watching](https://he ## Community vs. SAP Distribution of abapGit -This website is documenting the community version of abapGit (available on [GitHub](https://github.com/abapGit/abapGit)). The SAP version of abapGit available as part of SAP Business Technology Platform is documented on [help.sap.com](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/d62ed9d54a764c53990f25f0ab6c27f9.html). When using the SAP version, please note that there are different capabilities and supported object types (as described by SAP). If the SAP version on BTP does not work correctly, open a ticket with SAP support. +This website is documenting the community version of abapGit (available on [GitHub](https://github.com/abapGit/abapGit)). The SAP version of abapGit available that is part of SAP Business Technology Platform and SAP S/4HANA Cloud is documented on [help.sap.com](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/d62ed9d54a764c53990f25f0ab6c27f9.html). When using the SAP version, please note that there are different capabilities and supported object types (as described by SAP). If the SAP version does not work correctly, open a [ticket with SAP support](https://me.sap.com/servicessupport/cases). diff --git a/src/user-guide/getting-started/install.md b/src/user-guide/getting-started/install.md index db76a6581..4b46d85d4 100755 --- a/src/user-guide/getting-started/install.md +++ b/src/user-guide/getting-started/install.md @@ -11,6 +11,10 @@ abapGit exists in 2 flavours: _standalone_ version or _developer_ version. * The standalone version is targeted at users. It consists of one (huge) program which contains all the needed code. You run the standalone version in transaction `SE38`, executing the program you created. * The developer version is targeted at developers contributing to the abapGit codebase. It consists of all the ABAP programs/classes/interfaces/etc. of the abapGit project. You run the developer version with transaction `ZABAPGIT`. Only the developer version supports parallel processing, so it might be of interest to you even if you do not intend to contribute. +::: warning +There's also an SAP version of abapGit available that is part of SAP Business Technology Platform and SAP S/4HANA Cloud. It's documented on [help.sap.com](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/d62ed9d54a764c53990f25f0ab6c27f9.html). When using the SAP version, note that there are different capabilities and supported object types (as described by SAP). If the SAP version does not work correctly, open a [ticket with SAP support](https://me.sap.com/servicessupport/cases). +::: + ## Prerequisites abapGit requires SAP BASIS version 702 or higher.