#301 (comment): added some information (#315)

masesgroup · Nov 18, 2023 · 18aca67 · 18aca67
1 parent 14a3b0a
commit 18aca67
Show file tree

Hide file tree

Showing 18 changed files with 87 additions and 4 deletions.
diff --git a/src/documentation/api/index.md b/src/documentation/api/index.md
@@ -1,3 +1,8 @@
+---
+title: APIs of .NET suite for Apache Kafka
+_description: Describes the current available APIs of .NET suite for Apache Kafka
+---
+
 # KNet: .NET gateway for Apache Kafka APIs
 
 Open left menu to browse API
diff --git a/src/documentation/articles/API_extensibility.md b/src/documentation/articles/API_extensibility.md
@@ -1,3 +1,8 @@
+---
+title: APIs extendibility of .NET suite for Apache Kafka
+_description: Describes how to extend available APIs of .NET suite for Apache Kafka
+---
+
 # KNet: APIs extendibility
 
 What to do if an API was not yet implemented? The simplest answer is: help us to make this product reacher :-)

diff --git a/src/documentation/articles/commandlineswitch.md b/src/documentation/articles/commandlineswitch.md
@@ -1,3 +1,8 @@
+---
+title: Command-line switches of .NET suite for Apache Kafka
+_description: Describes the command-line switches of .NET suite for Apache Kafka
+---
+
 # KNet: Command line switches available
 
 _knet_ accepts the following command-line switches:

diff --git a/src/documentation/articles/connectSDK.md b/src/documentation/articles/connectSDK.md
@@ -1,3 +1,8 @@
+---
+title: Connect SDK of .NET suite for Apache Kafka
+_description: Describes how to use a connector build over KNet Connect SDK of .NET suite for Apache Kafka
+---
+
 # KNet: Connect SDK
 
 This is only a quick start guide, many other information related to Apache Kafka Connect can be found at the following link https://kafka.apache.org/documentation/#connect

diff --git a/src/documentation/articles/currentstate.md b/src/documentation/articles/currentstate.md
@@ -1,3 +1,8 @@
+---
+title: Current development state of .NET suite for Apache Kafka
+_description: Describes the current development state of .NET suite for Apache Kafka
+---
+
 # KNet: development state
 
 This release comes with some ready made classes:

diff --git a/src/documentation/articles/howtobuild.md b/src/documentation/articles/howtobuild.md
@@ -1,3 +1,8 @@
+---
+title: How to build .NET suite for Apache Kafka
+_description: Describes how to build the Java/JVM suite for .NET from scatch
+---
+
 # KNet: How to build from scratch
 
 If the user clones the repo, the following steps shall be done to use the project. The full steps can be found within the repo, under the **.github\workflows** folder.

diff --git a/src/documentation/articles/intro.md b/src/documentation/articles/intro.md
@@ -1,3 +1,8 @@
+---
+title: .NET suite for Apache Kafka
+_description: Main page of .NET suite for Apache Kafka
+---
+
 # KNet: .NET suite for Apache Kafka
 
 KNet is a comprehensive .NET suite for [Apache Kafka](https://kafka.apache.org/) providing access to all [APIs](https://kafka.apache.org/documentation/#api) and features: Producer, Consumer, Admin, Streams, Connect, backends (ZooKeeper and Kafka).

diff --git a/src/documentation/articles/jvm_callbacks.md b/src/documentation/articles/jvm_callbacks.md
@@ -1,3 +1,8 @@
+---
+title: JVM callbacks within .NET suite for Apache Kafka powered code
+_description: Describes how to manage callbacks from JVM using the .NET suite for Apache Kafka
+---
+
 # KNet: JVM callbacks
 
 One of the features of [JCOBridge](https://www.jcobridge.com/), used in KNet, is the callback management from JVM.

diff --git a/src/documentation/articles/performance.md b/src/documentation/articles/performance.md
@@ -1,4 +1,7 @@
-% KNet performance
+---
+title: Performance of .NET suite for Apache Kafka
+_description: Describes the performance evaluation of .NET suite for Apache Kafka
+---
 
 # KNet: performance evaluation
 
@@ -235,8 +238,6 @@ Looking at the above table KNet performs better than Confluent.Kafka.
 
 Looking at value within the brackets, that represents the ratio of the SD, it is possible to highlight that the more stable values are available with packet size higher than 100 bytes.
 
-
-
 ## Final considerations
 
 The KNet library performs better when the massages are larger; when the messages are small Confluent.Kafka performs better.

diff --git a/src/documentation/articles/roadmap.md b/src/documentation/articles/roadmap.md
@@ -1,3 +1,8 @@
+---
+title: Roadmap of .NET suite for Apache Kafka
+_description: Describes the roadmap of .NET suite for Apache Kafka
+---
+
 # KNet roadmap
 
 The roadmap can be synthetized in the following points:

diff --git a/src/documentation/articles/usage.md b/src/documentation/articles/usage.md
@@ -1,3 +1,8 @@
+---
+title: Usage of .NET suite for Apache Kafka
+_description: Describes how to use .NET suite for Apache Kafka
+---
+
 # KNet: library usage
 
 To use KNet classes the developer can write code in .NET using the same classes available in the official Apache Kafka package.

diff --git a/src/documentation/articles/usageCLI.md b/src/documentation/articles/usageCLI.md
@@ -1,3 +1,8 @@
+---
+title: CLI interface of .NET suite for Apache Kafka
+_description: Describes how to use CLI interface of .NET suite for Apache Kafka
+---
+
 # KNet: CLI
 
 ## Installation

diff --git a/src/documentation/articles/usageConnect.md b/src/documentation/articles/usageConnect.md
@@ -1,3 +1,8 @@
+---
+title: Kafka Connect SDK of .NET suite for Apache Kafka
+_description: Describes how to use Kafka Connect SDK of .NET suite for Apache Kafka
+---
+
 # KNet: KNet Connect SDK
 
 ## Installation

diff --git a/src/documentation/articles/usagePS.md b/src/documentation/articles/usagePS.md
@@ -1,3 +1,8 @@
+---
+title: PowerShell module of .NET suite for Apache Kafka
+_description: Describes how to use PowerShell module of .NET suite for Apache Kafka
+---
+
 # KNet: PowerShell Module
 
 ## Installation

diff --git a/src/documentation/articles/usageSerDes.md b/src/documentation/articles/usageSerDes.md
@@ -1,3 +1,8 @@
+---
+title: Serialization usage of .NET suite for Apache Kafka
+_description: Describes how to use serialization of .NET suite for Apache Kafka
+---
+
 # KNet: Serializer/Deserializer
 
 KNet comes with a base set of serializer and deserializer. Most of them are usable with primitives types (bool, int, etc) and array of bytes.

diff --git a/src/documentation/articles/usageTemplates.md b/src/documentation/articles/usageTemplates.md
@@ -1,3 +1,8 @@
+---
+title: Templates usage of .NET suite for Apache Kafka
+_description: Describes how to use templates of .NET suite for Apache Kafka
+---
+
 # KNet: 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/docfx.json b/src/documentation/docfx.json
@@ -55,8 +55,10 @@
     "globalMetadata": {
 	  "_appLogoPath": "images/logo.png",
       "_appFaviconPath": "images/favicon.ico",
-      "_appTitle": "MASES Group website - KNet",
+      "_appTitle": "MASES Group - KNet",
       "_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 KNet, the .NET suite for Apache Kafka",
+	  "_lang": "en",
       "_gitContribute": {
 
       }

diff --git a/src/documentation/index.md b/src/documentation/index.md
@@ -1,3 +1,8 @@
+---
+title: .NET suite for Apache Kafka
+_description: Main page of .NET suite for Apache Kafka
+---
+
 # KNet: .NET suite for Apache Kafka
 
 KNet is a comprehensive .NET suite for [Apache Kafka](https://kafka.apache.org/) providing access to all [APIs](https://kafka.apache.org/documentation/#api) and features: Producer, Consumer, Admin, Streams, Connect, backends (ZooKeeper and Kafka).