From cc5ab0c075d647eb28291f863c79e5728cdb85d3 Mon Sep 17 00:00:00 2001 From: larshp Date: Thu, 18 May 2017 17:16:15 +0000 Subject: [PATCH] more more files --- docs/_data/navigation.yml | 14 +++---- docs/ref-dot-abapgit.md | 63 +++++++++++++++++++++++++++++++ docs/ref-supported.md | 78 +++++++++++++++++++++++++++++++++++++++ docs/ref-write-protect.md | 17 +++++++++ 4 files changed, 164 insertions(+), 8 deletions(-) create mode 100644 docs/ref-dot-abapgit.md create mode 100644 docs/ref-supported.md create mode 100644 docs/ref-write-protect.md diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 9b9034f56..438aae9b5 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -27,14 +27,12 @@ - title: Reference items: - - title: Global settings - - file: foo - title: foo - subitems: - - file: bar - title: bar - - file: moo - title: moo + - title: .abapgit.xml + file: ref-dot-abapgit + - title: Write protect + file: ref-write-protect + - title: Supported object types + file: ref-supported - title: Other items: diff --git a/docs/ref-dot-abapgit.md b/docs/ref-dot-abapgit.md new file mode 100644 index 000000000..048821b08 --- /dev/null +++ b/docs/ref-dot-abapgit.md @@ -0,0 +1,63 @@ +--- +title: .abapgit.xml +--- + +**.abapgit.xml** is a special abapGit file. It contains meta information of the abapGit project. + +Example: abapGit own .abapgit.xml + +```xml + + + + + E + /src/ + PREFIX + + /.travis.yml + /CONTRIBUTING.md + /LICENSE + /README.md + /package.json + /changelog.txt + + + + +``` + +# Description + +## Master Language + +The language in which all documentation and dictionary elements texts will be created. Follows SAP `sy-langu` values. + +## Starting Folder + +The Git repository folder that defines the root folder where deserialization starts. + +## Folder Logic + +abapGit follows two folder logics: PREFIX and FULL + +### PREFIX + +A package name must contain its parent package name as a prefix. Examples: + +Valid prefix: +* ZFOO + * **ZFOO**_BAR + * **ZFOO_BAR**_QUX + +Invalid prefix: +* ZFOO + * ZBAR + +### FULL + +Any package name is accepted + +## Ignore + +Files which abapGit will not download into your ABAP system. \ No newline at end of file diff --git a/docs/ref-supported.md b/docs/ref-supported.md new file mode 100644 index 000000000..b75a22d73 --- /dev/null +++ b/docs/ref-supported.md @@ -0,0 +1,78 @@ +--- +title: Supported object types +--- + + +Type | Description | Supported +:------------ | :------------ | ------------: +ACID | Checkpoint Group | Yes +AUTH | Authorization Check Fields | Yes +BOBF | BOPF: Business Object Model | [Plugin](https://github.com/larshp/abapGit-Plugins) +CLAS | Class (ABAP Objects) | Yes +CMOD | Customer enhancement projects | [#151](https://github.com/larshp/abapGit/issues/151) +DCLS | ABAP Data Control Language Sources | Yes +DDLS | Data Definition Language Source | Yes +DOCT | General Text | Yes +DOCV | Documentation (Independent) | Yes +DOMA | Domain | Yes +DTEL | Data Element | Yes +ECAT | eCATT Test Script | [#163](https://github.com/larshp/abapGit/issues/163) +ECTD | eCATT Test Data Container | [#105](https://github.com/larshp/abapGit/issues/105) +ENHC | Composite Enhancement Implementation | Yes +ENHO | Enhancement Implementation | Partial [#113](https://github.com/larshp/abapGit/issues/113) +ENHS | Enhancement Spot | Yes +ENQU | Lock Object | Yes +FORM | SAPscript form | [#39](https://github.com/larshp/abapGit/issues/39) +FUGR | Function Group | Yes +IAMU | Language-Independent IAC Binary Data | [#81](https://github.com/larshp/abapGit/issues/81) +IARP | Parameters of IAC Language Resource | Yes +IASP | Parameters of an IAC service | Yes +IATU | Language-Independent IAC Templates | Yes +IWPR | Gateway Business Suite Enablement - Service Builder Project | [#75](https://github.com/larshp/abapGit/issues/75) +LPDC | Launchpad short texts | [#107](https://github.com/larshp/abapGit/issues/107) +MSAG | Message Class | Yes +NROB | Number Range Objects | Yes +PARA | SPA/GPA Parameters | Yes +PDTS | Standard Task | [#153](https://github.com/larshp/abapGit/issues/153) +PDWS | Workflow templates | [#154](https://github.com/larshp/abapGit/issues/154) +PINF | Package interface | Yes +PROG | Program | Yes +SAMC | ABAP Messaging Channels | Yes +SAPC | ABAP Push Channels | Yes +SFBF | Business Function + Assignment | Yes +SFBS | Business Function Set + Assignment | Yes +SFSW | Switch + Assignment of Objects to the Switch | Yes +SHI3 | General structure storage: Definition of a structure | Yes +SHLP | Search Help | Yes +SICF | ICF Service | Yes +SPLO | Format Types | Yes +SRFC | RFC Service | [#155](https://github.com/larshp/abapGit/issues/155) +SSFO | SAP Smart Form | Yes +SSST | SAP Smart Style | Yes +SFPI | Form Object: Interface | Yes +SFPF | Form Object: Form | Yes +SHMA | Shared Objects: Defined Area Attributes | [#85](https://github.com/larshp/abapGit/issues/85) +SMIM | Info Object from the MIME Repository | Yes +SPRX | Proxy Object | [#87](https://github.com/larshp/abapGit/issues/87) +STYL | SAPscript style | Yes +SUSC | Authorization object class | Yes +SUSO | Authorization object | Yes +SXCI | Business Add-Ins - Implementations | [#156](https://github.com/larshp/abapGit/issues/156) +TABL | Table | Yes +TOBJ | Definition of a Maintenance and Transport Object | Yes +TRAN | Transaction | Yes +TTYP | Table Type | Yes +TYPE | Type Group | Yes +VCLS | View cluster | Yes +VIEW | View | Yes +W3HT | Web Reporting/Internet Transaction Server HTML Templates | Yes +W3MI | Web Reporting/Internet Transaction Server MIME Types(binary | Yes +WAPA | BSP (Business Server Pages) Application | Yes +WDCA | Web Dynpro Application Configuration | [#79](https://github.com/larshp/abapGit/issues/79) +WDCC | Web Dynpro Component Configuration | [#78](https://github.com/larshp/abapGit/issues/78) +WDYA | Web Dynpro Application | Yes +WDYN | Web Dynpro Component | Yes +WEBI | Virtual End Point | Yes +XSLT | Transformation | Yes + +Also see https://github.com/larshp/abapGit-Plugins \ No newline at end of file diff --git a/docs/ref-write-protect.md b/docs/ref-write-protect.md new file mode 100644 index 000000000..749f57247 --- /dev/null +++ b/docs/ref-write-protect.md @@ -0,0 +1,17 @@ +--- +title: Write protect +--- + +The write protected repository feature will make sure users cannot overwrite objects in the SAP system with objects from the git repository. So it helps enforcing that data can only go from the SAP system to the Git repository. + +The feature disables pulls, uninstall of all objects, switching branches etc. + +To enable: + +1. from the abapGit main screen: Advanced -> Database util + +2. find the repository, click "Edit" + +3. find the value `` and replace with `X` + +4. restart abapGit(just to make sure caches are cleared) \ No newline at end of file