Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
masesdevelopers committed Nov 12, 2024
1 parent 64304c7 commit 65fe56b
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 27 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Currently the project tries to support, at our best, the [supported Apache Kafka
- branch [master](https://github.com/masesgroup/KNet)
- KNet version 2.9.*
- Apache Kafka™ version 3.8.*:
- branch [master](https://github.com/masesgroup/KNet)
- branch [release/2.8.X](https://github.com/masesgroup/KNet)
- KNet version 2.8.*
- Apache Kafka™ version 3.7.*:
- branch [release/2.7.X](https://github.com/masesgroup/KNet/tree/release/2.7.X)
Expand Down
12 changes: 4 additions & 8 deletions src/documentation/articles/howtobuild.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ If the user clones the repo, the following steps shall be done to use the projec

Let's start with the tools needed to achieve the goal:
* An installed version of __git for Windows__
* An installed version of .NET 6 SDK
* An installed version of .NET 8 SDK
* An installed version of Apache Maven (> 3.8.1)

Then the steps are the following (the steps are made for Windows shell):
Expand Down Expand Up @@ -42,19 +42,15 @@ Then the steps are the following (the steps are made for Windows shell):
The final result shall look like this:
* RootFolder
* bin
* net5.0
* config
* jars
* other folders
* net6.0
* config
* jars
* other folders
* net461
* net8.0
* config
* jars
* netcoreapp3.1
* other folders
* net462
* config
* jars
* other folders
* Other folders
34 changes: 17 additions & 17 deletions src/documentation/articles/intro.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: .NET suite for Apache Kafkaâ„¢
_description: Main page of .NET suite for Apache Kafkaâ„¢
title: .NET suite for Apache Kafka™
_description: Main page of .NET suite for Apache Kafka™
---

# KNet: .NET suite for [Apache Kafkaâ„¢](https://kafka.apache.org/)
# KNet: .NET suite for [Apache Kafka™](https://kafka.apache.org/)

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™).
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™).

### Libraries and Tools

Expand All @@ -21,41 +21,41 @@ KNet is a comprehensive .NET suite for [Apache Kafka™](https://kafka.apache.or

### Project disclaimer

KNet is a suite for Apache Kafkaâ„¢, curated by MASES Group, can be supported by the open-source community.
KNet is a suite for Apache Kafka™, curated by MASES Group, can be supported by the open-source community.

Its primary scope is to support other, public or internal, MASES Group projects: open-source community and commercial entities can use it for their needs and support this project, moreover there are dedicated community and commercial subscription plans.

The repository code and releases may contain bugs, the release cycle depends from Apache Kafkaâ„¢ release cycle, critical discovered issues and/or enhancement requested from this or other projects.
The repository code and releases may contain bugs, the release cycle depends from Apache Kafka™ release cycle, critical discovered issues and/or enhancement requested from this or other projects.

Looking for the help of Apache Kafkaâ„¢ experts? MASES Group can help you design, build, deploy, and manage Apache Kafkaâ„¢ clusters and streaming applications.
Looking for the help of Apache Kafka™ experts? MASES Group can help you design, build, deploy, and manage Apache Kafka™ clusters and streaming applications.

---

## Scope of the project

This project aims to create a set of libraries and tools to direct access, from .NET, all the features available in the [Apache Kafkaâ„¢ binary distribution](https://kafka.apache.org/downloads).
This project aims to create a set of libraries and tools to direct access, from .NET, all the features available in the [Apache Kafka™ binary distribution](https://kafka.apache.org/downloads).

There are many client libraries written to manage communication with Apache Kafkaâ„¢. Conversely, this project use directly the Java packages released from The Apache Foundation giving more than one benefit:
There are many client libraries written to manage communication with Apache Kafka™. Conversely, this project use directly the Java packages released from The Apache Foundation giving more than one benefit:
* all implemented features are availables at no extra implementation costs, see [KNet usage](usage.md);
* avoids any third party communication protocol implementation;
* access all features made available from Apache Kafkaâ„¢: the most important are Apache Kafkaâ„¢ Streams and Apache Kafkaâ„¢ Connect which does not have any C# implementation;
* access all features made available from Apache Kafka™: the most important are Apache Kafka™ Streams and Apache Kafka™ Connect which does not have any C# implementation;
* measured high [performance](performance.md) in many operating conditions.

Currently the project tries to support, at our best, the [supported Apache Kafkaâ„¢ binary distribution](https://kafka.apache.org/downloads):
- Apache Kafkaâ„¢ version 3.9.*:
Currently the project tries to support, at our best, the [supported Apache Kafka™ binary distribution](https://kafka.apache.org/downloads):
- Apache Kafka™ version 3.9.*:
- branch [master](https://github.com/masesgroup/KNet)
- KNet version 2.9.*
- Apache Kafkaâ„¢ version 3.8.*:
- branch [master](https://github.com/masesgroup/KNet)
- Apache Kafka™ version 3.8.*:
- branch [release/2.8.X](https://github.com/masesgroup/KNet)
- KNet version 2.8.*
- Apache Kafkaâ„¢ version 3.7.*:
- Apache Kafka™ version 3.7.*:
- branch [release/2.7.X](https://github.com/masesgroup/KNet/tree/release/2.7.X)
- KNet version 2.7.*
- Apache Kafkaâ„¢ version 3.6.*:
- Apache Kafka™ version 3.6.*:
- branch [release/2.6.X](https://github.com/masesgroup/KNet/tree/release/2.6.X)
- KNet version 2.6.*

The Apache Kafkaâ„¢ packages are downloaded from:
The Apache Kafka™ packages are downloaded from:

|kafka-clients | kafka-streams | kafka-tools | kafka_2.13 |
|:---: |:---: |:---: |:---: |
Expand Down
5 changes: 4 additions & 1 deletion src/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,11 @@ There are many client libraries written to manage communication with Apache Kafk
* measured high [performance](articles/performance.md) in many operating conditions.

Currently the project tries to support, at our best, the [supported Apache Kafka™ binary distribution](https://kafka.apache.org/downloads):
- Apache Kafka™ version 3.8.*:
- Apache Kafka™ version 3.9.*:
- branch [master](https://github.com/masesgroup/KNet)
- KNet version 2.9.*
- Apache Kafka™ version 3.8.*:
- branch [release/2.8.X](https://github.com/masesgroup/KNet)
- KNet version 2.8.*
- Apache Kafka™ version 3.7.*:
- branch [release/2.7.X](https://github.com/masesgroup/KNet/tree/release/2.7.X)
Expand Down

0 comments on commit 65fe56b

Please sign in to comment.