From 56cbe749562148611b30b4396470cf3c0582f59a Mon Sep 17 00:00:00 2001 From: MASES Public Developers Team <94312179+masesdevelopers@users.noreply.github.com> Date: Sat, 18 Nov 2023 04:28:30 +0100 Subject: [PATCH] https://github.com/masesgroup/KEFCore/issues/162#issuecomment-1817344746: added some information (#175) --- src/documentation/api/index.md | 7 ++++++- src/documentation/articles/currentstate.md | 5 +++++ src/documentation/articles/externalapplication.md | 5 +++++ src/documentation/articles/gettingstarted.md | 5 +++++ src/documentation/articles/howitworks.md | 5 +++++ src/documentation/articles/intro.md | 5 +++++ src/documentation/articles/kafkadbcontext.md | 5 +++++ src/documentation/articles/roadmap.md | 5 +++++ src/documentation/articles/serialization.md | 5 +++++ src/documentation/articles/usage.md | 5 +++++ src/documentation/articles/usageTemplates.md | 5 +++++ src/documentation/articles/usecases.md | 5 +++++ src/documentation/docfx.json | 4 +++- src/documentation/index.md | 5 +++++ 14 files changed, 69 insertions(+), 2 deletions(-) diff --git a/src/documentation/api/index.md b/src/documentation/api/index.md index 3ac1be8a..33688f92 100644 --- a/src/documentation/api/index.md +++ b/src/documentation/api/index.md @@ -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 diff --git a/src/documentation/articles/currentstate.md b/src/documentation/articles/currentstate.md index b9750286..f3c33d61 100644 --- a/src/documentation/articles/currentstate.md +++ b/src/documentation/articles/currentstate.md @@ -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: diff --git a/src/documentation/articles/externalapplication.md b/src/documentation/articles/externalapplication.md index 0a89aea4..ed4b8df5 100644 --- a/src/documentation/articles/externalapplication.md +++ b/src/documentation/articles/externalapplication.md @@ -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. diff --git a/src/documentation/articles/gettingstarted.md b/src/documentation/articles/gettingstarted.md index 37bf0324..d8365d7f 100644 --- a/src/documentation/articles/gettingstarted.md +++ b/src/documentation/articles/gettingstarted.md @@ -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: diff --git a/src/documentation/articles/howitworks.md b/src/documentation/articles/howitworks.md index a7aee02a..7aec29c6 100644 --- a/src/documentation/articles/howitworks.md +++ b/src/documentation/articles/howitworks.md @@ -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). diff --git a/src/documentation/articles/intro.md b/src/documentation/articles/intro.md index c9d87ba0..d42d8188 100644 --- a/src/documentation/articles/intro.md +++ b/src/documentation/articles/intro.md @@ -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/). diff --git a/src/documentation/articles/kafkadbcontext.md b/src/documentation/articles/kafkadbcontext.md index d399a4b0..8763f523 100644 --- a/src/documentation/articles/kafkadbcontext.md +++ b/src/documentation/articles/kafkadbcontext.md @@ -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/): diff --git a/src/documentation/articles/roadmap.md b/src/documentation/articles/roadmap.md index 2f45647d..f01a006b 100644 --- a/src/documentation/articles/roadmap.md +++ b/src/documentation/articles/roadmap.md @@ -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: diff --git a/src/documentation/articles/serialization.md b/src/documentation/articles/serialization.md index 90a11acd..863b5a20 100644 --- a/src/documentation/articles/serialization.md +++ b/src/documentation/articles/serialization.md @@ -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. diff --git a/src/documentation/articles/usage.md b/src/documentation/articles/usage.md index c90f2dbd..5e17cc19 100644 --- a/src/documentation/articles/usage.md +++ b/src/documentation/articles/usage.md @@ -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. diff --git a/src/documentation/articles/usageTemplates.md b/src/documentation/articles/usageTemplates.md index 40ecd105..9ef31ef3 100644 --- a/src/documentation/articles/usageTemplates.md +++ b/src/documentation/articles/usageTemplates.md @@ -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. diff --git a/src/documentation/articles/usecases.md b/src/documentation/articles/usecases.md index 51e9d3ef..0805755a 100644 --- a/src/documentation/articles/usecases.md +++ b/src/documentation/articles/usecases.md @@ -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. diff --git a/src/documentation/docfx.json b/src/documentation/docfx.json index 67650291..9b5f6c3a 100644 --- a/src/documentation/docfx.json +++ b/src/documentation/docfx.json @@ -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": "
Copyright © 2023 MASES s.r.l.. | Via San Cesidio 16 - San Valentino in A.C. - PE | P.I. 01932310681
", + "_description": "This is a descriptive page of Entity Framework Core provider for Apache Kafka", + "_lang": "en", "_gitContribute": { } diff --git a/src/documentation/index.md b/src/documentation/index.md index cc8819b8..76dd7bf5 100644 --- a/src/documentation/index.md +++ b/src/documentation/index.md @@ -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/).