Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

https://github.com/masesgroup/KEFCore/issues/162#issuecomment-1817344746: added some information #175

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/documentation/api/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# KafkaBridge .NET API documentation
---
title: APIs of KEFCore
_description: Describes the current available APIs of Entity Framework Core provider for Apache Kafka
---

# .NET API documentation of Entity Framework Core provider for Apache Kafka

Open left menu to browse API
5 changes: 5 additions & 0 deletions src/documentation/articles/currentstate.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Current development state of KEFCore
_description: Describes the current development state of Entity Framework Core provider for Apache Kafka
---

# KEFCore: development state

The latest release implementes these features:
Expand Down
5 changes: 5 additions & 0 deletions src/documentation/articles/externalapplication.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: External applications of KEFCore
_description: Describes how to use data managed by Entity Framework Core provider for Apache Kafka from external applications
---

# KEFCore: external application

[Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) shall convert the entities used within the model in something viable from the backend.
Expand Down
5 changes: 5 additions & 0 deletions src/documentation/articles/gettingstarted.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Getting started with KEFCore
_description: Describes how to start to use Entity Framework Core provider for Apache Kafka
---

# KEFCore: Getting started

To use [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) you must have at least:
Expand Down
5 changes: 5 additions & 0 deletions src/documentation/articles/howitworks.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: How KEFCore works
_description: Describes how works Entity Framework Core provider for Apache Kafka
---

# KEFCore: how it works

[Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) can be used in some [operative conditions](usecases.md).
Expand Down
5 changes: 5 additions & 0 deletions src/documentation/articles/intro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Entity Framework Core provider for Apache Kafka
_description: Main page of Entity Framework Core provider for Apache Kafka
---

# KEFCore: [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/)

KEFCore is the [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/).
Expand Down
5 changes: 5 additions & 0 deletions src/documentation/articles/kafkadbcontext.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: KafkaDbContext
_description: Describe what is and how use KafkaDbContext class from Entity Framework Core provider for Apache Kafka
---

# KEFCore: KafkaDbContext

`KafkaDbContext` is a special class which helps to define the `DbContext` and use [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/):
Expand Down
5 changes: 5 additions & 0 deletions src/documentation/articles/roadmap.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Roadmap of KEFCore
_description: Describes current roadmap of Entity Framework Core provider for Apache Kafka
---

# KEFCore: roadmap

The roadmap can be synthetized in the following points:
Expand Down
5 changes: 5 additions & 0 deletions src/documentation/articles/serialization.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Serialization in KEFCore
_description: Describes how works the serialization in Entity Framework Core provider for Apache Kafka
---

# KEFCore: serialization

[Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) shall convert the entities used within the model in something viable from the backend.
Expand Down
5 changes: 5 additions & 0 deletions src/documentation/articles/usage.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Usage of KEFCore
_description: Describes how to use Entity Framework Core provider for Apache Kafka
---

# KEFCore usage

Read [Getting started](gettingstarted.md) to find out info and tips.
Expand Down
5 changes: 5 additions & 0 deletions src/documentation/articles/usageTemplates.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Templates usage of KEFCore
_description: Describes how to use templates of Entity Framework Core provider for Apache Kafka
---

# KEFCore: Template Usage Guide

For more information related to .NET templates look at https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-new-sdk-templates.
Expand Down
5 changes: 5 additions & 0 deletions src/documentation/articles/usecases.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Use cases of KEFCore
_description: Describes some use cases of Entity Framework Core provider for Apache Kafka
---

# KEFCore: use cases

[Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/) can be used in some operative conditions.
Expand Down
4 changes: 3 additions & 1 deletion src/documentation/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,10 @@
"globalMetadata": {
"_appLogoPath": "images/logo.png",
"_appFaviconPath": "images/favicon.ico",
"_appTitle": "MASES Group website - Entity Framework Core provider for Apache Kafka",
"_appTitle": "MASES Group - Entity Framework Core provider for Apache Kafka",
"_appFooter": "<div style=\"text-align: center;\">Copyright © 2023 MASES s.r.l.. | Via San Cesidio 16 - San Valentino in A.C. - PE | P.I. 01932310681</div>",
"_description": "This is a descriptive page of Entity Framework Core provider for Apache Kafka",
"_lang": "en",
"_gitContribute": {

}
Expand Down
5 changes: 5 additions & 0 deletions src/documentation/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Entity Framework Core provider for Apache Kafka
_description: Main page of Entity Framework Core provider for Apache Kafka
---

# KEFCore: [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/)

KEFCore is the [Entity Framework Core](https://learn.microsoft.com/it-it/ef/core/) provider for [Apache Kafka](https://kafka.apache.org/).
Expand Down
Loading