Getting Started section: review #1464
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Linting Errors
- about/index.md:34:57 No empty links [Context: "[Bad Practices]()"]
- about/index.md:74:107 No empty links [Context: "[*entity-relationship modellin"]
- about/index.md:110:69 No empty links [Context: "[navigation]()"]
- about/index.md:110:46 No empty links [Context: "[infix filters]()"]
- about/index.md:187:22 No empty links [Context: "[Focus on Domain]()"]
- about/index.md:187:201 No empty links [Context: "[Extensibility]()"]
- about/index.md:187:156 No empty links [Context: "[Separation of Concerns]()"]
- about/index.md:187:117 No empty links [Context: "[aspect-oriented modeling]()"]
- about/index.md:187:271 No empty links [Context: "[composition]()"]
- about/index.md:187:227 No empty links [Context: "[customization]()"]
- about/index.md:187:246 No empty links [Context: "[verticalization]()"]
- about/index.md:208:69 No empty links [Context: "[key features & benefits]()"]
- about/index.md:260:192 No empty links [Context: "[Providing Services]()"]
- about/index.md:260:66 No empty links [Context: "[single-purposed service]()"]
- get-started/index.md:152 Fenced code blocks should have a language specified
Spelling Mistakes
Generally, for each spelling mistake there are 2 ways to fix it:
- Fix the spelling mistake and commit it.
- The word is incorrectly reported as misspelled → put the word on the project-words.txt list, located in the root project directory.
| @@ -31,11 +31,11 @@ The structure of this primer is influenced by Simon Lewis' approach in *[The Art | |||
| #### The Art | |||
|
|
|||
| - applies the science as best and simple as possible → [*Key Features & Qualities*]() | |||
| - tries to avoid common misttakes as much as possible → *[Bad Bractices]()* | |||
| - tries to avoid common mistakes as much as possible → *[Bad Practices]()* | |||
There was a problem hiding this comment.
No empty links. Please provide a link value.
|
|
||
| #### Entity-Relationship Models | ||
|
|
||
| Data models capture the *static* aspects of a domain using the commonly known and widely used approach of [*entity-relationship modelling*](). A simplistic one looks like this in CDS: | ||
| Data models capture the *static* aspects of a domain using the commonly known and widely used approach of [*entity-relationship modelling*](). A simple one looks like this in CDS: |
There was a problem hiding this comment.
No empty links. Please provide a link value.
| @@ -108,7 +107,7 @@ entity EnglishBooks as select from Books | |||
| where author.country.code = 'GB'; | |||
| ``` | |||
|
|
|||
| ... or, even more compact using *[infix filters]()* and [*navigation*](), like that: | |||
| This is an even more compact version, using *[infix filters]()* and [*navigation*](): | |||
There was a problem hiding this comment.
No empty links. Please provide a link value.
| @@ -108,7 +107,7 @@ entity EnglishBooks as select from Books | |||
| where author.country.code = 'GB'; | |||
| ``` | |||
|
|
|||
| ... or, even more compact using *[infix filters]()* and [*navigation*](), like that: | |||
| This is an even more compact version, using *[infix filters]()* and [*navigation*](): | |||
There was a problem hiding this comment.
No empty links. Please provide a link value.
| > | ||
| > CDS greatly promotes [***Focus on Domain***]() by a *concise* and *comprehensible* language. Intrinsic support for *[aspect-oriented modeling]()* fosters *[**Separation of Concerns**]()*, as well as *[**Extensibility**]()* in [customization](), [verticalization](), and [composition]() scenarios. | ||
| :::tip Key features & qualities | ||
| CDS greatly promotes [***Focus on Domain***]() by a *concise* and *comprehensible* language. Intrinsic support for *[aspect-oriented modeling]()* fosters *[**Separation of Concerns**]()*, as well as *[**Extensibility**]()* in [customization](), [verticalization](), and [composition]() scenarios. |
There was a problem hiding this comment.
No empty links. Please provide a link value.
| > | ||
| > CDS greatly promotes [***Focus on Domain***]() by a *concise* and *comprehensible* language. Intrinsic support for *[aspect-oriented modeling]()* fosters *[**Separation of Concerns**]()*, as well as *[**Extensibility**]()* in [customization](), [verticalization](), and [composition]() scenarios. | ||
| :::tip Key features & qualities | ||
| CDS greatly promotes [***Focus on Domain***]() by a *concise* and *comprehensible* language. Intrinsic support for *[aspect-oriented modeling]()* fosters *[**Separation of Concerns**]()*, as well as *[**Extensibility**]()* in [customization](), [verticalization](), and [composition]() scenarios. |
There was a problem hiding this comment.
No empty links. Please provide a link value.
| > | ||
| > As depicted in the figure above, these design principles — and hence adherence to them — is crucial for many of the [key features and benefits](). | ||
| :::tip Design principles and benefits | ||
| The design principles - and adherence to them - are crucial for the [key features & benefits](). |
There was a problem hiding this comment.
No empty links. Please provide a link value.
| > | ||
| > The example above is a good example for the recommended best practice of a *[single-purposed service]()* which is specialised on *one* specific use case and group of users. Learn more about that in the [Providing Services]() guide. | ||
| :::tip Example for single-purposed service | ||
| The previous example follows the recommended best practice of a *[single-purposed service]()* which is specialized on *one* specific use case and group of users. Learn more about that in the [Providing Services]() guide. |
There was a problem hiding this comment.
No empty links. Please provide a link value.
| > | ||
| > The example above is a good example for the recommended best practice of a *[single-purposed service]()* which is specialised on *one* specific use case and group of users. Learn more about that in the [Providing Services]() guide. | ||
| :::tip Example for single-purposed service | ||
| The previous example follows the recommended best practice of a *[single-purposed service]()* which is specialized on *one* specific use case and group of users. Learn more about that in the [Providing Services]() guide. |
There was a problem hiding this comment.
No empty links. Please provide a link value.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…into rjegl11/get-started
There was a problem hiding this comment.
Linting Errors
- about/index.md:416:36 No empty links [Context: "[Generic Service Providers]()"]
Spelling Mistakes
Generally, for each spelling mistake there are 2 ways to fix it:
- Fix the spelling mistake and commit it.
- The word is incorrectly reported as misspelled → put the word on the project-words.txt list, located in the root project directory.
| > [!tip] | ||
| > | ||
| > In effect, this is what makes CAP a **model-driven framework**: We use the captured declarative information about data and services to automatically serve all CRUD requests, including complex deep queries, with expands, where clauses and order by, aggregations, and so forth... | ||
| Similarly, CAP runtimes bootstrap *[Generic Service Providers]()* for services defined in service models. They use the information at runtime to translate incoming requests from a querying protocol, such as OData, into SQL queries sent to the database. |
There was a problem hiding this comment.
No empty links. Please provide a link value.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Still ongoing but wanted to share that I'm working on it.