Skip to content

Commit 52019dc

Browse files
authored
Add documentation (#204)
* Add documentation * Add more documentation * Bump CRDs version * Fix * And one more fix * Headling fix
1 parent c0c5f24 commit 52019dc

File tree

6 files changed

+688
-11
lines changed

6 files changed

+688
-11
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<img src="docs/images/arcane-logo.png" width="100" height="100" alt="logo">
44

55
[![Run tests with coverage](https://github.com/SneaksAndData/arcane-operator/actions/workflows/build.yaml/badge.svg)](https://github.com/SneaksAndData/arcane-operator/actions/workflows/build.yaml)
6-
[![C#](https://img.shields.io/badge/C%23-8-blue.svg)](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-versioning)
6+
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/sneaksAndData/arcane-operator)
77
![GitHub Release Date](https://img.shields.io/github/release-date/sneaksanddata/arcane-operator)
88

99

@@ -83,18 +83,24 @@ The most significant milestones are listed below:
8383

8484
- [x] Support for ZIO-based streaming plugins
8585
- [ ] Add contribution guidelines
86-
- [ ] Rewrite the operator in Go
86+
- [x] Rewrite the operator in Go
8787
- [ ] Complete transition from Akka.NET to ZIO for the remaining streaming plugins
8888

8989
# Streaming plugins
9090

91-
### Available ZIO-based streaming plugins
91+
## Available ZIO-based streaming plugins
9292
* Sql Server streaming plugin: [arcane-stream-sqlserver-change-tracking](https://github.com/SneaksAndData/arcane-stream-sqlserver-change-tracking)
9393
* Microsoft Synapse streaming plugin: [arcane-stream-microsoft-synapse-link](https://github.com/SneaksAndData/arcane-stream-microsoft-synapse-link)
94+
* Parquet streaming plugin: [arcane-stream-parquet](https://github.com/SneaksAndData/arcane-stream-parquet)
95+
* JSON streaming plugin: [arcane-stream-json](https://github.com/SneaksAndData/arcane-stream-json)
9496

95-
### Available Akka-based streaming plugins
97+
## Available Akka-based streaming plugins
9698
* REST-api streaming plugin: [arcane-stream-rest-api](https://github.com/SneaksAndData/arcane-stream-rest-api)
9799

100+
# User guide
101+
Detailed Arcane user guide is available in the [docs/user_guide.md](docs/usage.md) file.
102+
User scenarios cheat sheet is available in the [docs/user_scenarios.md](docs/user_scenarios.md) file.
103+
98104

99105
# Monitoring and observability
100106
-- TBD --

0 commit comments

Comments
 (0)