diff --git a/cds/assets/csn.drawio.svg b/cds/assets/csn.drawio.svg index edb450ef8..69e25aa81 100644 --- a/cds/assets/csn.drawio.svg +++ b/cds/assets/csn.drawio.svg @@ -1,4 +1,4 @@ - + @@ -27,13 +27,13 @@
- CDS + CDl
- CDS + CDl diff --git a/cds/cdl.md b/cds/cdl.md index 3bbef4f4c..ce0a2a2bc 100644 --- a/cds/cdl.md +++ b/cds/cdl.md @@ -1398,7 +1398,7 @@ extend Books:price.value with (precision:12,scale:3); ``` The extended type or element directly must have the respective property. -For multiple conflicting `extend` statements, the last `extend` wins, i.e. in three files `a.cds <- b.cds <- c.cds`, where `<-` means `using from`, +For multiple conflicting `extend` statements, the last `extend` wins, that means in three files `a.cds <- b.cds <- c.cds`, where `<-` means `using from`, the `extend` from `c.cds` is applied, as it is the last in the dependency chain. diff --git a/cds/index.md b/cds/index.md index 20e1f777c..9ccefe088 100644 --- a/cds/index.md +++ b/cds/index.md @@ -6,7 +6,7 @@ status: released Language Reference Documentation { .subtitle} -CDS is the backbone of the SAP Cloud Application Programming Model (CAP). It provides the means to declaratively capture service definitions and data models, queries, and expressions in plain (JavaScript) object notations. CDS features to parse from a variety of source languages and to compile them into various target languages. +CDL is the backbone of the SAP Cloud Application Programming Model (CAP). It provides the means to declaratively capture service definitions and data models, queries, and expressions in plain (JavaScript) object notations. CDL features to parse from a variety of source languages and to compile them into various target languages. Though the language used within `.cds` files is CDL, we usually use the terms _CDS_ or _CDS Models_ as synonyms to keep it simple where we don't need to care about technical details too much. The graphic is explained in the accompanying text. diff --git a/get-started/in-a-nutshell.md b/get-started/in-a-nutshell.md index 776f98106..1ea88b286 100644 --- a/get-started/in-a-nutshell.md +++ b/get-started/in-a-nutshell.md @@ -395,7 +395,7 @@ Open __ / __ in your browser and s As [previously shown](#deployed-in-memory), `cds watch` automatically bootstraps an SQLite in-process and in-memory database by default — that is, unless told otherwise. While this **isn't meant for productive use**, it drastically speeds up development turn-around times, essentially by mocking your target database, for example, SAP HANA. {.impl .node} -[Learn more about mocking options in **Grow as you go**.](./grow-as-you-go){.learn-more .impl .node} +[Learn more about mocking options in **Jumpstart Development**.](./jumpstart){.learn-more .impl .node} ### H2 In-Memory {.impl .java} diff --git a/get-started/learning-sources.md b/get-started/learning-sources.md index 9ce5a2979..8a51d1096 100644 --- a/get-started/learning-sources.md +++ b/get-started/learning-sources.md @@ -5,7 +5,7 @@ status: released # Learning Sources -In here, we collected several interesting learning resources for you. Not all of them are maintained by the CAP team, not all of them cover CAP in its entirety, but they are well prepared sources we can recommend for your learning. From the short description we provide for every resource, you're hopefully able to tell if that fits to the need you're currently having. +In here, we collected several interesting learning resources for you. Not all of them are maintained by the CAP team, not all of them cover CAP in its entirety, but they are well prepared sources we can recommend for your learning. ::: tip Contributions Welcome... We're just getting started with this page. Please help us in that endeavour by [adding/proposing resources](https://github.com/cap-js/docs/pulls) that helped you and also to improve the descriptions. Just press e to start making your contribution. diff --git a/guides/data-privacy/audit-logging.md b/guides/data-privacy/audit-logging.md index fc61231b9..e87439b78 100644 --- a/guides/data-privacy/audit-logging.md +++ b/guides/data-privacy/audit-logging.md @@ -152,7 +152,7 @@ A more comprehensive guide, incl. tutorials, is currently under development. -For deployment in general, please follow the [deployment guide](../deployment/). Check the rest of this guide before actually triggering the deployment (i.e., executing `cf deploy`). +For deployment in general, please follow the [deployment guide](../deployment/). Check the rest of this guide before actually triggering the deployment (that is, executing `cf deploy`). Here is what you need to do additionally, to integrate with SAP Audit Log Service: diff --git a/guides/querying.md b/guides/querying.md index d0e22891f..cb2e80f7a 100644 --- a/guides/querying.md +++ b/guides/querying.md @@ -21,7 +21,7 @@ breadcrumbs: ## Overview — Why Querying? -We all know querying from SQL databases: we use queries to express which data we're interested in, by applying *selection* — i.e., filtering the *rows* to fetch data for —, and *projection* — choosing data attributes. The database engine interprets the query and calculates an optimized execution plan, to collect and return the requested data. +We all know querying from SQL databases: we use queries to express which data we're interested in, by applying *selection* — that is, filtering the *rows* to fetch data for —, and *projection* — choosing data attributes. The database engine interprets the query and calculates an optimized execution plan, to collect and return the requested data. ### Example Using Querying diff --git a/guides/security/overview.md b/guides/security/overview.md index 2992d1101..dea450f64 100644 --- a/guides/security/overview.md +++ b/guides/security/overview.md @@ -165,8 +165,8 @@ It can be deployed as application (reusable module) or alternatively consumed as - The optional CAP sidecar (reusable module) is used to outsource application-independent tasks such as providing multitenancy and extension support. -Application providers, i.e. platform users, have privileged access to the application zone. -In contrast, application subscribers, i.e. business users, are restricted to a minimal interface. +Application providers, that is platform users, have privileged access to the application zone. +In contrast, application subscribers, that is business users, are restricted to a minimal interface. ::: warning ❗ Application providers **may not share any secrets from the application zone** such as binding information with other components or persons. diff --git a/node.js/authentication.md b/node.js/authentication.md index 2e06d8241..dba241cad 100644 --- a/node.js/authentication.md +++ b/node.js/authentication.md @@ -105,14 +105,14 @@ this.before('*', function (req) { }) ``` -Alternatively, you can also use the ready-to-use instance `cds.User.privileged` directly, i.e., `const user = cds.User.privileged`. +Alternatively, you can also use the ready-to-use instance `cds.User.privileged` directly, that is, `const user = cds.User.privileged`. ## cds.**User.Anonymous** { #anonymous-user .class } Class `cds.User.Anonymous` allows you to instantiate an anonymous user (`const user = new cds.User.Anonymous`), for example in a [custom authentication](#custom) implementation. -Alternatively, you can also use the ready-to-use instance `cds.User.anonymous` directly, i.e., `const user = cds.User.anonymous`. +Alternatively, you can also use the ready-to-use instance `cds.User.anonymous` directly, that is, `const user = cds.User.anonymous`. ## cds.**User.default** { #default-user .property } diff --git a/node.js/cds-reflect.md b/node.js/cds-reflect.md index 0c3ae7319..40e175c87 100644 --- a/node.js/cds-reflect.md +++ b/node.js/cds-reflect.md @@ -394,7 +394,7 @@ class cds.struct extends cds.type {...} ### . is_struct {.property} A tag property which is `true` for linked struct definitions (types and elements).
-It is also `true` for linked entity definitions, i.e., instances of as [`cds.entity`](#cds-entity). {.indent} +It is also `true` for linked entity definitions, that is, instances of as [`cds.entity`](#cds-entity). {.indent} ### . elements {.property} diff --git a/node.js/cds-tx.md b/node.js/cds-tx.md index 0ddb78c70..f500dd39f 100644 --- a/node.js/cds-tx.md +++ b/node.js/cds-tx.md @@ -102,7 +102,7 @@ This usage variant, which accepts a function with nested operations ...
::: tip -**Only in non-managed environments** — as said above: you don't need to care for that if you are in a managed environment, i.e., when implementing an event handler. In that case, the core service runtime automatically created a transaction for you already. +**Only in non-managed environments** — as said above: you don't need to care for that if you are in a managed environment, that is, when implementing an event handler. In that case, the core service runtime automatically created a transaction for you already. ::: ::: warning _❗ Warning_ @@ -307,7 +307,7 @@ tx = Object.create (srv, Object.getOwnPropertyDescriptors({ In effect, `tx` objects ... -* are concrete context-specific — i.e. tenant-specific — incarnations of `srv`es +* are concrete context-specific — that is tenant-specific — incarnations of `srv`es * support all the [Service API](core-services) methods like `run`, `create` and `read` * support methods `tx.commit` and `tx.rollback` as documented below. diff --git a/node.js/core-services.md b/node.js/core-services.md index 075095664..1c32bec86 100644 --- a/node.js/core-services.md +++ b/node.js/core-services.md @@ -777,7 +777,7 @@ this.on ('error', (err, req) => { }) ``` -Error handlers are invoked whenever an error occurs during event processing of *all* potential events and requests, and are used to augment or modify error messages, before they go out to clients. They are expected to be a sync function, i.e., **not `async`**, not returning Promises. +Error handlers are invoked whenever an error occurs during event processing of *all* potential events and requests, and are used to augment or modify error messages, before they go out to clients. They are expected to be a sync function, that is, **not `async`**, not returning Promises. @@ -1046,7 +1046,7 @@ All matching `.before`, `.on`, and `.after` handlers are executed in correspondi - ***concurrently*** for instances of `cds.Event` - **`after`** handlers are always executed *concurrently* -In effect, for asynchronous event messages, i.e., instances of `cds.Event`, sent via [`srv.emit()`](#srv-emit-event), all registered `.on` handlers are always executed. In contrast to that, for synchronous resuests, i.e., instances of `cds.Requests` this is up to the individual handlers calling `next()`. See [`srv.on(request)`](#interceptor-stack-with-next) for an example. +In effect, for asynchronous event messages, that is, instances of `cds.Event`, sent via [`srv.emit()`](#srv-emit-event), all registered `.on` handlers are always executed. In contrast to that, for synchronous resuests, that is, instances of `cds.Requests` this is up to the individual handlers calling `next()`. See [`srv.on(request)`](#interceptor-stack-with-next) for an example. diff --git a/node.js/index.md b/node.js/index.md index 8733cfec0..caf697ba5 100644 --- a/node.js/index.md +++ b/node.js/index.md @@ -16,8 +16,8 @@ As an application developer you'd primarily use the Node.js APIs documented here 2. Add service implementations → [`cds.Service` > Implementations](./core-services#implementing-services) 3. Register custom event handlers in which → [`srv.on`/`before`/`after`](./core-services#srv-on-before-after) 4. Read/write data from other services in which → [`srv.run`](./core-services#srv-run-query) + [`cds.ql`](./cds-ql) -5. ..., i.e. from your primary database → [`cds.DatabaseService`](./databases) -5. ..., i.e. from other connected services → [`cds.RemoteService`](./remote-services) +5. ..., that is from your primary database → [`cds.DatabaseService`](./databases) +5. ..., that is from other connected services → [`cds.RemoteService`](./remote-services) 6. Emit and handle asynchronous events → [`cds.MessagingService`](./messaging) All the rest is largely handled by the CAP runtime framework behind the scenes. diff --git a/tools/cds-editors.md b/tools/cds-editors.md index f63cff8ff..c653f9f7f 100644 --- a/tools/cds-editors.md +++ b/tools/cds-editors.md @@ -220,7 +220,7 @@ Default: *ActiveEditorOnly* Keeps track of the active editor in focus. Only changes there are immediately validated. -The *ActiveEditorOnly* mode is especially useful in situations when navigating through a large model, that is having multiple files open (even if they are not shown as tabs) +The *ActiveEditorOnly* mode is especially useful in situations when navigating through a large model, that is, having multiple files open (even if they are not shown as tabs) and editing a file that the others directly or indirectly depend on. ::: warning Large models can lead to **high CPU and memory load** @@ -235,7 +235,7 @@ The high resource consumption might impact the editor's responsiveness. Default: *on* -This setting enables extended support for annotations, that is refined diagnostics and code completion. Can be switched *off* for performance gains. +This setting enables extended support for annotations, that is, refined diagnostics and code completion. Can be switched *off* for performance gains. ##### Cds > Workspace: ScanCsn @@ -335,7 +335,7 @@ To enable the limit value above, switch *on*. - Commands _Go to References_ / _Find All References_ will recompile all models that might have changed due to a change in a depending model. If there are index models, it often means that the complete workspace is being recompiled. Until a further change, reference calculation is reasonably fast. - Command _Go to Symbol in Workspace_ will recompile the complete workspace once, after that it is reasonable fast. -- Changing settings in _CDS_ section will currently perform a complete workspace invalidation i.e. required indexes will lead to recompilations on demand as described above. +- Changing settings in _CDS_ section will currently perform a complete workspace invalidation, that is, required indexes will lead to recompilations on demand as described above. - Changing certain `cds.env` settings, for example folder configurations, will invalidate the workspace as well. ### CDS Source Formatter { #cds-formatter}