Update README files#8
Conversation
| @@ -4,7 +4,7 @@ For more information about this example check the [Readme](../README.md). | |||
|
|
|||
| ## Prerequisite | |||
There was a problem hiding this comment.
We discussed this case with Editorial Insights. "X is a prerequisite for Y" sounds perfectly fine in a sentence, but I feel uncomfortable when it is used as a heading and we have just one item.
I assume (but I didn't check code) that out example is configured so that we expect data at this specific port. We can convert this section into a note and say something like: "In this example, the server uses/runs on/available at port 5005. To change the port, update the following line ".
Alternatively, we can change the heading to "Access the Server" or something similar.
There was a problem hiding this comment.
I feel we will miss the point of informing the user that they need to start the OData server before starting the app/dev server. I propose the following modifications to your suggestions:
| ## Prerequisite | |
| ## Access the Server | |
| Start the [ODataServer](../ODataServer) before running the application. This example is configured to access the ODataServer at port 5005. To change this configuration, update the following line: [app.component.ts#L13](/Angular/src/app/app.component.ts#L13) |
There was a problem hiding this comment.
Good point. It was not obvious in the original version. A minor update:
| ## Prerequisite | |
| ## Start the Server | |
| Start the [ODataServer](../ODataServer) before you run the application. This example is configured to access the ODataServer at port 5005. To change this configuration, update the following line: [app.component.ts#L13](/Angular/src/app/app.component.ts#L13) |
| An [ASP.NET Core OData 8](https://learn.microsoft.com/en-us/odata/webapi-8/overview) project that creates OData endpoints. | ||
|
|
||
| ## Overview | ||
|
|
||
| This server exposes product data through OData endpoints, enabling advanced querying capabilities such as filtering, sorting, selecting specific fields, and more through standardized OData query options. | ||
| This server creates OData endpoints to expose sample data. You can use standardized OData queries to access data and run filtering, selection, and sorting operations. |
There was a problem hiding this comment.
Please double-check if this is technically accurate.
| An [ASP.NET Core OData 8](https://learn.microsoft.com/en-us/odata/webapi-8/overview) project that creates OData endpoints. | |
| ## Overview | |
| This server exposes product data through OData endpoints, enabling advanced querying capabilities such as filtering, sorting, selecting specific fields, and more through standardized OData query options. | |
| This server creates OData endpoints to expose sample data. You can use standardized OData queries to access data and run filtering, selection, and sorting operations. | |
| The [ASP.NET Core OData 8](https://learn.microsoft.com/en-us/odata/webapi-8/overview) library creates OData endpoints to expose sample data. You can use standardized OData queries to access and filter, select, and sort data. |
There was a problem hiding this comment.
I'm not sure it is 100% correct to say that the library itself creates the OData endpoints, I propose the following modifications to your suggesstion:
This [ASP.NET Core OData 8](https://learn.microsoft.com/en-us/odata/webapi-8/overview) project creates OData endpoints to expose sample data. You can use standardized OData queries to access and filter, select, and sort data.
There was a problem hiding this comment.
Can we call "ASP.NET Core OData 8" an application or a solution? I was confused at first and had to read Microsoft intro to understand what project is in this context. If no, let's leave your version.
There was a problem hiding this comment.
"ASP.NET Core OData 8" is a library that our app in the ODataServer path uses. Given this is the main library used in this application, yeah we can say "This ASP.NET Core OData 8 application creates..."
| # DevExtreme DataGrid - Bind to an OData Service | ||
|
|
||
| This example demonstrates how to bind the DevExtreme DataGrid component to an OData v4 service. It shows how to configure the ODataStore for server-side data operations including filtering, selecting specific fields, and querying product data. | ||
| This example demonstrates how to bind the DevExtreme DataGrid component to an OData v4 service. An ODataStore is configured to run server-side data operations including filtering, selection, and sorting. |
There was a problem hiding this comment.
Please, clarify what "ODataStore" is. Project? Class? Service?
| This example demonstrates how to bind the DevExtreme DataGrid component to an OData v4 service. An ODataStore is configured to run server-side data operations including filtering, selection, and sorting. | |
| This example binds the DevExtreme DataGrid component to an OData v4 service. An ODataStore is configured to run server-side data operations including filtering, selection, and sorting. |
There was a problem hiding this comment.
It is a service/data store.
| ``` | ||
| The server will be available at `http://localhost:5005`. | ||
| 1. **Start the OData Server** | ||
| Run the following command to start the OData server: |
There was a problem hiding this comment.
| Run the following command to start the OData server: | |
| Execute the following command to start the OData server: |
|
|
||
| 2. **Run the Client Application:** | ||
| Run one of the following commands to start the client application: |
There was a problem hiding this comment.
| 2. **Run the Client Application:** | |
| Run one of the following commands to start the client application: | |
| 2. **Run the Client Application:** | |
| Run one of the following commands to run the client application: |
| dotnet run | ||
| ``` | ||
|
|
||
| The server starts at the following URL: `http://localhost:5005`. |
There was a problem hiding this comment.
| The server starts at the following URL: `http://localhost:5005`. | |
| The server is available at the following URL: `http://localhost:5005`. |
| ``` | ||
|
|
||
| The application will be available at `http://localhost:59183` . | ||
| The application starts at the following URL: `http://localhost:59183` . |
| This example binds the DevExtreme DataGrid component to an OData v4 service. An ODataStore is configured to run server-side data operations including filtering, selection, and sorting. | ||
|
|
||
| ## Implementation Overview | ||
| ## Implementation Steps |
There was a problem hiding this comment.
| ## Implementation Steps | |
| ## Implementation Details |
| 1. Create an [ODataStore](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/). Use its properties to specify the service's [url](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/Configuration/#url), [key](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/Configuration/#key) data field, and OData [version](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/Configuration/#version). | ||
| 2. You can configure **ODataStore** as a standalone element (see [OData](https://js.devexpress.com/Documentation/Guide/Data_Binding/Specify_a_Data_Source/OData/) for details), but this examples uses a [DataSource](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/) to demonstrate data [filtering](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#filter) and data fields [selection](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#select). | ||
| 1. Create an [ODataStore](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/). Specify the service [url](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/Configuration/#url), [key](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/Configuration/#key) data field, and OData [version](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/Configuration/#version). | ||
| 2. You can configure a standalone **ODataStore** (see [OData](https://js.devexpress.com/Documentation/Guide/Data_Binding/Specify_a_Data_Source/OData/) for details), but this examples uses a [DataSource](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/) to implement data [filtering](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#filter) and [selection](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#select) operations. |
There was a problem hiding this comment.
Since we have an article...
| 2. You can configure a standalone **ODataStore** (see [OData](https://js.devexpress.com/Documentation/Guide/Data_Binding/Specify_a_Data_Source/OData/) for details), but this examples uses a [DataSource](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/) to implement data [filtering](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#filter) and [selection](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#select) operations. | |
| 2. You can configure a standalone **ODataStore** service (see [OData](https://js.devexpress.com/Documentation/Guide/Data_Binding/Specify_a_Data_Source/OData/) for details), but this examples uses a [DataSource](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/) to implement data [filtering](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#filter) and [selection](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#select) operations. |
No description provided.