Skip to content

Commit d20b158

Browse files
authored
fixed TOC (#150)
1 parent c17ff0e commit d20b158

File tree

1 file changed

+5
-18
lines changed

1 file changed

+5
-18
lines changed

README.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,19 @@ a [CDS plugin](https://cap.cloud.sap/docs/node.js/cds-plugins#cds-plugin-package
66

77
> [!IMPORTANT]
88
> This release establishes support for multi-tenant deployments using MTX and extensibility.
9+
> This release establishes support for multi-tenant deployments using MTX and extensibility.
910
>
1011
> To achieve this, the code was modified significantly. While we tested extensively, there still may be glitches or unexpected situations which we did not cover. So please **test this release extensively before applying it to productive** scenarios. Please also report any bugs or glitches, ideally by contributing a test-case for us to incorporate.
12+
> To achieve this, the code was modified significantly. While we tested extensively, there still may be glitches or unexpected situations which we did not cover. So please **test this release extensively before applying it to productive** scenarios. Please also report any bugs or glitches, ideally by contributing a test-case for us to incorporate.
1113
>
1214
> See the changelog for a full list of changes
1315
1416
> [!Warning]
1517
>
1618
> When using multi-tenancy with MTX, the generated facets and associations have to be created by the model provider of the MTX component. Therefore, the plugin also must be added to the `package.json` of the MTX sidecar.
1719
>Although we tested this scenario extensively, there still might be cases where the automatic generation will not work as expected. If this happends in your scenario, we suggest using the `@changelog.disable_assoc` ([see here](#disable-association-to-changes-generation)) for all tracked entities and to add the association and facet manually to the service entity.
20+
> When using multi-tenancy with MTX, the generated facets and associations have to be created by the model provider of the MTX component. Therefore, the plugin also must be added to the `package.json` of the MTX sidecar.
21+
>Although we tested this scenario extensively, there still might be cases where the automatic generation will not work as expected. If this happends in your scenario, we suggest using the `@changelog.disable_assoc` ([see here](#disable-association-to-changes-generation)) for all tracked entities and to add the association and facet manually to the service entity.
1822
1923

2024
### Table of Contents
@@ -76,6 +80,7 @@ To enable change tracking, simply add this self-configuring plugin package to yo
7680
npm add @cap-js/change-tracking
7781
```
7882
If you use multi-tenancy, please add the plugin also to the MTX poroject.
83+
If you use multi-tenancy, please add the plugin also to the MTX poroject.
7984

8085
### 3. Annotations
8186

@@ -267,24 +272,6 @@ You can turn this behavior off globally by adding the following switch to the `p
267272

268273
This section describes modelling cases for further reference, from simple to complex, including the following:
269274

270-
- [Change Tracking Plugin for SAP Cloud Application Programming Model (CAP)](#change-tracking-plugin-for-sap-cloud-application-programming-model-cap)
271-
- [Table of Contents](#table-of-contents)
272-
- [Try it Locally](#try-it-locally)
273-
- [1. Prerequisites](#1-prerequisites)
274-
- [2. Setup](#2-setup)
275-
- [3. Annotations](#3-annotations)
276-
- [4. Testing](#4-testing)
277-
- [Change History View](#change-history-view)
278-
- [Detailed Explanation](#detailed-explanation)
279-
- [Human-readable Types and Fields](#human-readable-types-and-fields)
280-
- [Human-readable IDs](#human-readable-ids)
281-
- [Human-readable Values](#human-readable-values)
282-
- [Advanced Options](#advanced-options)
283-
- [Altered table view](#altered-table-view)
284-
- [Disable lazy loading](#disable-lazy-loading)
285-
- [Disable UI Facet generation](#disable-ui-facet-generation)
286-
- [Disable Association to Changes Generation](#disable-association-to-changes-generation)
287-
- [Preserve change logs of deleted data](#preserve-change-logs-of-deleted-data)
288275
- [Examples](#examples)
289276
- [Specify Object ID](#specify-object-id)
290277
- [Use Case 1: Annotate single field/multiple fields of associated table(s) as the Object ID](#use-case-1-annotate-single-fieldmultiple-fields-of-associated-tables-as-the-object-id)

0 commit comments

Comments
 (0)