Skip to content

Commit

Permalink
Update documentation after commit 935ae75 (#283)
Browse files Browse the repository at this point in the history
Co-authored-by: masesdevelopers <94312179+masesdevelopers@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and masesdevelopers authored Sep 20, 2024
1 parent 935ae75 commit 103693f
Show file tree
Hide file tree
Showing 13 changed files with 117 additions and 117 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h1 id="MASES_EntityFrameworkCore_KNet_Serialization_Protobuf_ProtobufKEFCoreSer
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ProtobufKEFCoreSerDes.Key&lt;T&gt; : ISerDesSelector&lt;T&gt;, ISerDesSelector where T : class, IMessage&lt;T&gt;</code></pre>
<pre><code class="lang-csharp hljs">public class ProtobufKEFCoreSerDes.Key&lt;T&gt; : ISerDesSelector&lt;T&gt;, ISerDesSelector</code></pre>
</div>


Expand Down
4 changes: 2 additions & 2 deletions docs/articles/currentstate.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<title>Current development state of KEFCore | MASES Group - Entity Framework Core provider for Apache Kafka </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Current development state of KEFCore | MASES Group - Entity Framework Core provider for Apache Kafka ">
<meta name="description" content="Describes the current development state of Entity Framework Core provider for Apache Kafka">
<meta name="description" content="Describes the current development state of Entity Framework Core provider for Apache Kafka">

<link rel="icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
Expand Down Expand Up @@ -85,7 +85,7 @@ <h1 id="kefcore-development-state">KEFCore: development state</h1>

<p>The latest release implementes these features:</p>
<ul>
<li>[x] A working provider based on Apache Kafka Streams</li>
<li>[x] A working provider based on Apache Kafka Streams</li>
<li>[x] The provider can use KNetCompactedReplicator</li>
<li>[x] A base package for serialization based on .NET Json serializers</li>
<li>[x] An external package for serialization based on Apache Avro serializers</li>
Expand Down
10 changes: 5 additions & 5 deletions docs/articles/externalapplication.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<title>External applications of KEFCore | MASES Group - Entity Framework Core provider for Apache Kafka </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="External applications of KEFCore | MASES Group - Entity Framework Core provider for Apache Kafka ">
<meta name="description" content="Describes how to use data managed by Entity Framework Core provider for Apache Kafka from external applications">
<meta name="description" content="Describes how to use data managed by Entity Framework Core provider for Apache Kafka from external applications">

<link rel="icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
Expand Down Expand Up @@ -83,14 +83,14 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<article data-uid="">
<h1 id="kefcore-external-application">KEFCore: external application</h1>

<p><a href="https://learn.microsoft.com/it-it/ef/core/">Entity Framework Core</a> provider for <a href="https://kafka.apache.org/">Apache Kafka</a> shall convert the entities used within the model in something viable from the backend.
Continuing from the concepts introduced in <a href="serialization.html">serialization</a>, an external application can use the data stored in the topics in a way it decides: <a href="https://learn.microsoft.com/it-it/ef/core/">Entity Framework Core</a> provider for <a href="https://kafka.apache.org/">Apache Kafka</a> gives some helpers to get back the CLR Entity objects stored in the topics.</p>
<p><a href="https://learn.microsoft.com/it-it/ef/core/">Entity Framework Core</a> provider for <a href="https://kafka.apache.org/">Apache Kafka</a> shall convert the entities used within the model in something viable from the backend.
Continuing from the concepts introduced in <a href="serialization.html">serialization</a>, an external application can use the data stored in the topics in a way it decides: <a href="https://learn.microsoft.com/it-it/ef/core/">Entity Framework Core</a> provider for <a href="https://kafka.apache.org/">Apache Kafka</a> gives some helpers to get back the CLR Entity objects stored in the topics.</p>
<blockquote>
<p>IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can change without notice.</p>
</blockquote>
<h2 id="basic-concepts">Basic concepts</h2>
<p>An external application may want to be informed about data changes in the topics and want to analyze the Entity was previously managed from the EFCore application.
Within the core packages there is the <code>EntityExtractor</code> class which contains, till now, few methods and one accepts a raw <code>ConsumerRecord&lt;byte[], byte[]&gt;</code> from Apache Kafka.
Within the core packages there is the <code>EntityExtractor</code> class which contains, till now, few methods and one accepts a raw <code>ConsumerRecord&lt;byte[], byte[]&gt;</code> from Apache Kafka.
The method reads the info stored in the <code>ConsumerRecord&lt;byte[], byte[]&gt;</code> and returns the Entity object with the filled properties.</p>
<p>It is possible to build a new application which subscribe to a topic created from the EFCore application.
The following is a possible snippet of the logic can be applied:</p>
Expand All @@ -116,7 +116,7 @@ <h3 id="mandatory-information">Mandatory information</h3>
<li>The model types (i.e. the types used to build the <code>DbContext</code> or <code>KafkaDbContext</code>)</li>
</ul>
<h2 id="possible-usages">Possible usages</h2>
<p>For possible usages of <a href="https://learn.microsoft.com/it-it/ef/core/">Entity Framework Core</a> provider for <a href="https://kafka.apache.org/">Apache Kafka</a>, and this feature, see <a href="usecases.html">use cases</a></p>
<p>For possible usages of <a href="https://learn.microsoft.com/it-it/ef/core/">Entity Framework Core</a> provider for <a href="https://kafka.apache.org/">Apache Kafka</a>, and this feature, see <a href="usecases.html">use cases</a></p>

</article>

Expand Down
8 changes: 4 additions & 4 deletions docs/articles/gettingstarted.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<title>Getting started with KEFCore | MASES Group - Entity Framework Core provider for Apache Kafka </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Getting started with KEFCore | MASES Group - Entity Framework Core provider for Apache Kafka ">
<meta name="description" content="Describes how to start to use Entity Framework Core provider for Apache Kafka">
<meta name="description" content="Describes how to start to use Entity Framework Core provider for Apache Kafka">

<link rel="icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
Expand Down Expand Up @@ -83,10 +83,10 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<article data-uid="">
<h1 id="kefcore-getting-started">KEFCore: Getting started</h1>

<p>To use <a href="https://learn.microsoft.com/it-it/ef/core/">Entity Framework Core</a> provider for <a href="https://kafka.apache.org/">Apache Kafka</a> you must have at least:</p>
<p>To use <a href="https://learn.microsoft.com/it-it/ef/core/">Entity Framework Core</a> provider for <a href="https://kafka.apache.org/">Apache Kafka</a> you must have at least:</p>
<ul>
<li>an installed JRE/JDK (11+)</li>
<li>an accessible Apache Kafka broker (a full cluster or a local Dockerized version)</li>
<li>an accessible Apache Kafka broker (a full cluster or a local Dockerized version)</li>
</ul>
<blockquote>
<p>IMPORTANT NOTE: till the first major version, all releases shall be considered not stable: this means the API public, or internal, can change without notice.</p>
Expand All @@ -98,7 +98,7 @@ <h2 id="first-project-setup">First project setup</h2>
<pre><code class="lang-pwsh">dotnet new console
</code></pre>
<ul>
<li>Entity Framework Core provider for Apache Kafka is available on <a href="https://www.nuget.org/packages/MASES.EntityFrameworkCore.KNet">NuGet</a>. Execute the following command to add the package to the newly created project:</li>
<li>Entity Framework Core provider for Apache Kafka is available on <a href="https://www.nuget.org/packages/MASES.EntityFrameworkCore.KNet">NuGet</a>. Execute the following command to add the package to the newly created project:</li>
</ul>
<pre><code class="lang-pwsh">dotnet add package MASES.EntityFrameworkCore.KNet
</code></pre>
Expand Down
Loading

0 comments on commit 103693f

Please sign in to comment.