reformat_dbt_sap_readme_and_update_yml (#36)

* reformat_dbt_sap_readme_and_update_yml

* Update CHANGELOG.md

Add PR # to changelog

* update_version_in_project.yml

* Update CHANGELOG.md

Co-authored-by: Joe Markiewicz <[email protected]>

* Update CHANGELOG.md

Co-authored-by: Joe Markiewicz <[email protected]>

* Update README.md

Co-authored-by: Joe Markiewicz <[email protected]>

* Update README.md

Co-authored-by: Joe Markiewicz <[email protected]>

* update_changelog_and_extractor_reports_yml

* Update README.md

Co-authored-by: Joe Markiewicz <[email protected]>

* Update CHANGELOG.md

Co-authored-by: Joe Markiewicz <[email protected]>

* Generate dbt docs via GitHub Actions

---------

Co-authored-by: Joe Markiewicz <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: 3 people

CHANGELOG.md

@@ -1,3 +1,12 @@
+# dbt_sap v0.3.1
+
+[PR #36](https://github.com/fivetran/dbt_sap/pull/36) includes the following updates:
+
+## Documentation
+- Updated the following column descriptions within the [sap__0fi_gl10](https://fivetran.github.io/dbt_sap/#!/model/model.sap.sap__0fi_gl_10) model: `accumulated_balance` and `turnover`. 
+  - `accumulated_balance` and `turnover` are both initially derived from the hslvt, tslvt, kslvt, and oslvt fields. They represent the balance carried forward from the previous fiscal year and are identical at the beginning of the first fiscal period. However, they diverge as subsequent transactions occur.
+  - hslvt, tslvt, kslvt, and oslvt are intentionally duplicated and aliased as hsmvt, tsmvt, ksmvt, and osmvt for legacy compatibility purposes.
+
 # dbt_sap v0.3.0
 
 [PR #34](https://github.com/fivetran/dbt_sap/pull/34) includes the following updates:

README.md

@@ -26,9 +26,11 @@
 
 <!--section=“sap_transformation_model"-->
 
-The following table provides a detailed list of all tables materialized within this package by default.
+The following tables provide a detailed list of all tables materialized within this package by default.
 > TIP: See more details about these tables in the package's [dbt docs site](https://fivetran.github.io/dbt_sap/#!/overview?g_v=1).
 
+## Extractor Reports
+
 | **Table**                         | **Description**                                                                                                                                                                                                                             |
 |--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | [sap__0comp_code_attr](https://fivetran.github.io/dbt_sap/#!/model/model.sap.sap__0comp_code_attr)    |  This model is used for loading company code attributes, extracting from the `t001` data source.                              |
@@ -42,6 +44,11 @@ The following table provides a detailed list of all tables materialized within t
 | [sap__0material_attr](https://fivetran.github.io/dbt_sap/#!/model/model.sap.sap__0material_attr)    |  This model is used to display material attribute information, originating from the `mara` source.                                                           |
 | [sap__0vendor_attr](https://fivetran.github.io/dbt_sap/#!/model/model.sap.sap__0vendor_attr)    |  This model is used to display vendor attributes, originating from the `lfa1` source.                           |
 | [sap__0vendor_text](https://fivetran.github.io/dbt_sap/#!/model/model.sap.sap__0vendor_text) |  This model is used to display vendor text, originating from the `lfa1` source.     |
+
+## Sales and Procurement
+
+| **Table**                         | **Description**                                                                                                                                                                                                                             |
+|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | [sap__dim_customer](https://fivetran.github.io/dbt_sap/#!/model/model.sap.sap__dim_customer) | Represents customer dimension data from the `kna1` source to support dimensional reporting. SAP field names are mapped to English readable column names. |
 | [sap__dim_material](https://fivetran.github.io/dbt_sap/#!/model/model.sap.sap__dim_material) | Provides enriched material and material type data by combining attributes from the `mara`, `makt`, `t134`, and `t134t` sources to support dimensional reporting. SAP field names are mapped to English readable column names. |
 | [sap__dim_plant](https://fivetran.github.io/dbt_sap/#!/model/model.sap.sap__dim_plant) | Delivers plant-level dimension data from the `t001w` source to support dimensional reporting. SAP field names are mapped to English readable column names. |

dbt_project.yml

@@ -1,6 +1,6 @@
 config-version: 2
 name: 'sap'
-version: '0.3.0'
+version: '0.3.1'
 require-dbt-version: [">=1.3.0", "<2.0.0"]
 
 models:

docs/catalog.json

@@ -1,5 +1,5 @@
 name: 'sap_integration_tests'
-version: '0.3.0'
+version: '0.3.1'
 profile: 'integration_tests'
 config-version: 2
 

docs/manifest.json

@@ -231,9 +231,9 @@ models:
       - name: credit_amount
         description: Total credit postings
       - name: accumulated_balance
-        description: Cumulated balance
+        description: accumulated balance from the previous fiscal period. Value initially derived from hslvt, tslvt, kslvt, or oslvt fields. Will match turnover at the beginning of the first fiscal period of the year
       - name: turnover
-        description: Sales of the period
+        description: Turnover amount from the previous fiscal period. Value initially derived from aliased hslvt, tslvt, kslvt, or oslvt fields (hsmvt/tsmvt/ksmvt/osmvt). Will match accumulated_value at the beginning of the first fiscal period of the year
 
   - name: sap__0fi_gl_14
     description: This model extracts line items from the leading ledger in new General Ledger Accounting.