This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar-dotpulsar.git
The following commit(s) were added to refs/heads/master by this push:
new e57acfa docs: merged docs and dev-docs into one folder (#158)
e57acfa is described below
commit e57acfaf1294f506f14b44854545624abf45a711
Author: entvex <[email protected]>
AuthorDate: Sun May 28 11:48:42 2023 +0200
docs: merged docs and dev-docs into one folder (#158)
---
.github/workflows/ci-unit.yaml | 2 +-
CONTRIBUTING.md | 2 +-
docs/.gitignore | 9 --
docs/api/.gitignore | 12 ++-
docs/api/{ => api}/.gitignore | 0
docs/api/{ => api}/index.md | 0
docs/{ => api}/assets/favicon.ico | Bin
docs/{ => api}/assets/pulsar.svg | 0
docs/{ => api}/docfx.json | 0
docs/api/index.md | 108 ++++++++++++++++++++-
docs/{ => api}/toc.yml | 0
.../dev}/assets/riderAutoCleanOnCommit.gif | Bin
.../dev}/assets/vs2022CleanOnSave.gif | Bin
.../dev}/assets/vs2022WithReSharper.gif | Bin
{dev-docs => docs/dev}/coding-style.md | 6 +-
docs/index.md | 107 --------------------
16 files changed, 119 insertions(+), 127 deletions(-)
diff --git a/.github/workflows/ci-unit.yaml b/.github/workflows/ci-unit.yaml
index 01ea509..765b933 100644
--- a/.github/workflows/ci-unit.yaml
+++ b/.github/workflows/ci-unit.yaml
@@ -68,4 +68,4 @@ jobs:
run: |
dotnet tool update -g docfx
dotnet build -p:TargetFramework=net7.0
- docfx docs/docfx.json
+ docfx docs/api/docfx.json
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8811c0f..0698943 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -48,7 +48,7 @@ The best way to create a minimal reproduction is gradually
removing code and dep
Please do:
-* **DO** follow our [coding style](/dev-docs/coding-style.md) (C#
code-specific).
+* **DO** follow our [coding style](/docs/dev/coding-style.md) (C#
code-specific).
* **DO** include tests when adding new features. When fixing bugs, start with
adding a test that highlights how the current behavior is broken.
* **DO** keep the discussions focused. When a new or related topic comes up
diff --git a/docs/.gitignore b/docs/.gitignore
deleted file mode 100644
index 11740bc..0000000
--- a/docs/.gitignore
+++ /dev/null
@@ -1,9 +0,0 @@
-###############
-# folder #
-###############
-/**/DROP/
-/**/TEMP/
-/**/packages/
-/**/bin/
-/**/obj/
-_site
diff --git a/docs/api/.gitignore b/docs/api/.gitignore
index e8079a3..11740bc 100644
--- a/docs/api/.gitignore
+++ b/docs/api/.gitignore
@@ -1,5 +1,9 @@
+###############
+# folder #
###############
-# temp file #
-###############
-*.yml
-.manifest
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site
diff --git a/docs/api/.gitignore b/docs/api/api/.gitignore
similarity index 100%
copy from docs/api/.gitignore
copy to docs/api/api/.gitignore
diff --git a/docs/api/index.md b/docs/api/api/index.md
similarity index 100%
copy from docs/api/index.md
copy to docs/api/api/index.md
diff --git a/docs/assets/favicon.ico b/docs/api/assets/favicon.ico
similarity index 100%
rename from docs/assets/favicon.ico
rename to docs/api/assets/favicon.ico
diff --git a/docs/assets/pulsar.svg b/docs/api/assets/pulsar.svg
similarity index 100%
rename from docs/assets/pulsar.svg
rename to docs/api/assets/pulsar.svg
diff --git a/docs/docfx.json b/docs/api/docfx.json
similarity index 100%
rename from docs/docfx.json
rename to docs/api/docfx.json
diff --git a/docs/api/index.md b/docs/api/index.md
index 39c888f..ca78b1e 100644
--- a/docs/api/index.md
+++ b/docs/api/index.md
@@ -1,3 +1,107 @@
-# API Documentation
+# DotPulsar
-This page hosts the API documentation of DotPulsar.
+The official .NET client library for [Apache
Pulsar](https://pulsar.apache.org/).
+
+DotPulsar is written entirely in C# and implements Apache Pulsar's [binary
protocol](https://pulsar.apache.org/docs/en/develop-binary-protocol/).
+
+## What's new?
+
+Have a look at the
[changelog](https://github.com/apache/pulsar-dotpulsar/blob/master/CHANGELOG.md).
+
+## Getting Started
+
+Let's take a look at a "Hello world" example, where we first produce a message
and then consume it. Note that the topic and subscription will be created if
they don't exist.
+
+First, we need a Pulsar setup. See [Pulsar
docs](https://pulsar.apache.org/docs/getting-started-home/) for how to set up a
local standalone Pulsar instance.
+
+Install the NuGet package
[DotPulsar](https://www.nuget.org/packages/DotPulsar/) and run the follow code
example:
+
+```csharp
+using DotPulsar;
+using DotPulsar.Extensions;
+
+const string myTopic = "persistent://public/default/mytopic";
+
+// connecting to pulsar://localhost:6650
+await using var client = PulsarClient.Builder().Build();
+
+// produce a message
+await using var producer =
client.NewProducer(Schema.String).Topic(myTopic).Create();
+await producer.Send("Hello World");
+
+// consume messages
+await using var consumer = client.NewConsumer(Schema.String)
+ .SubscriptionName("MySubscription")
+ .Topic(myTopic)
+ .InitialPosition(SubscriptionInitialPosition.Earliest)
+ .Create();
+
+await foreach (var message in consumer.Messages())
+{
+ Console.WriteLine($"Received: {message.Value()}");
+ await consumer.Acknowledge(message);
+}
+```
+
+For a more in-depth tour of the API, please visit the
[Wiki](https://github.com/apache/pulsar-dotpulsar/wiki).
+
+## Supported features
+
+- Service discovery
+- Automatic reconnect
+- TLS connections
+- Pulsar Proxy
+- Producer - send with custom metadata
+- Producer - send with event time, sequence id, and delayed message delivery
+- Producer - send with key and ordering key
+- Producer - partitioned topics
+- Consumer - subscription with initial position and priority level
+- Consumer - subscription types exclusive, shared, failover, and key shared
+- Consumer - receive and single + cumulative acknowledge
+- Consumer/Reader - seek on message-id and publish time
+- Consumer - unsubscribe
+- Consumer - compacted topics
+- Reader API
+- Read/Consume/Acknowledge batched messages
+- Telemetry
+ - [Tracing](https://github.com/apache/pulsar-dotpulsar/wiki/Tracing)
+ - [Metrics](https://github.com/apache/pulsar-dotpulsar/wiki/Metrics)
+- Authentication
+ - TLS Authentication
+ - JSON Web Token Authentication
+ - Custom Authentication
+- [Message
compression](https://github.com/apache/pulsar-dotpulsar/wiki/Compression)
+ - LZ4
+ - ZLIB
+ - ZSTD
+ - SNAPPY
+- Schemas
+ - Boolean
+ - Bytes (using `byte[]` and `ReadOnlySequence<byte>`)
+ - String (UTF-8, UTF-16, and US-ASCII)
+ - INT8, INT16, INT32, and INT64
+ - Float and Double
+ - Time (using TimeSpan)
+ - Timestamp and Date (using DateTime)
+
+For a horizontal comparison with more language-specific clients, see [Client
Feature Matrix](https://pulsar.apache.org/client-feature-matrix/).
+
+## Join Our Community
+
+Apache Pulsar has a [Slack instance](https://pulsar.apache.org/contact/), and
there you'll find us in the #dev-dotpulsar channel.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions
available, see the [tags on this
repository](https://github.com/apache/pulsar-dotpulsar/tags).
+
+## Contribution
+
+* **Daniel Blankensteiner** - *Initial work* - [Danske
Commodities](https://github.com/DanskeCommodities)
+
+Contributions are welcomed and greatly appreciated. See also the list of
[contributors](https://github.com/apache/pulsar-dotpulsar/contributors) who
participated in this project. Read the
[CONTRIBUTING](https://github.com/apache/pulsar-dotpulsar/blob/master/CONTRIBUTING.md)
guide for how to participate.
+
+If your contribution adds Pulsar features for C# clients, you need to update
both the [Pulsar docs](https://pulsar.apache.org/docs/client-libraries/) and
the [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/).
See [Contribution
Guide](https://pulsar.apache.org/contribute/site-intro/#pages) for more details.
+
+## License
+
+This project is licensed under [Apache License, Version
2.0](https://apache.org/licenses/LICENSE-2.0).
diff --git a/docs/toc.yml b/docs/api/toc.yml
similarity index 100%
rename from docs/toc.yml
rename to docs/api/toc.yml
diff --git a/dev-docs/assets/riderAutoCleanOnCommit.gif
b/docs/dev/assets/riderAutoCleanOnCommit.gif
similarity index 100%
rename from dev-docs/assets/riderAutoCleanOnCommit.gif
rename to docs/dev/assets/riderAutoCleanOnCommit.gif
diff --git a/dev-docs/assets/vs2022CleanOnSave.gif
b/docs/dev/assets/vs2022CleanOnSave.gif
similarity index 100%
rename from dev-docs/assets/vs2022CleanOnSave.gif
rename to docs/dev/assets/vs2022CleanOnSave.gif
diff --git a/dev-docs/assets/vs2022WithReSharper.gif
b/docs/dev/assets/vs2022WithReSharper.gif
similarity index 100%
rename from dev-docs/assets/vs2022WithReSharper.gif
rename to docs/dev/assets/vs2022WithReSharper.gif
diff --git a/dev-docs/coding-style.md b/docs/dev/coding-style.md
similarity index 94%
rename from dev-docs/coding-style.md
rename to docs/dev/coding-style.md
index db40723..4c2ddc7 100644
--- a/dev-docs/coding-style.md
+++ b/docs/dev/coding-style.md
@@ -56,7 +56,7 @@ But it will enforce small things, like an empty space at the
end of each cs file
1. In the commit window, click the gear icon.
2. Make sure only the "Cleanup 'DotPulsar: Full Cleanup' profile" is checked.
("Check TODO" can be left on or off according to your preference)
-
+
<!-- TOC --><a name="visual-studio-with-resharper"></a>
### Visual Studio with Resharper
@@ -67,7 +67,7 @@ But it will enforce small things, like an empty space at the
end of each cs file
4. Goto Profiles and make sure the profile 'DotPulsar: Full Cleanup' is set as
the default
5. Save
-
+
<!-- TOC --><a name="visual-studio"></a>
### Visual Studio.
@@ -79,7 +79,7 @@ To get Visual Studio to automatically enforce the code style
on file save, do th
3. Check the box "Run Code Cleanup profile on Save"
4. click ok
-
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
diff --git a/docs/index.md b/docs/index.md
deleted file mode 100644
index ca78b1e..0000000
--- a/docs/index.md
+++ /dev/null
@@ -1,107 +0,0 @@
-# DotPulsar
-
-The official .NET client library for [Apache
Pulsar](https://pulsar.apache.org/).
-
-DotPulsar is written entirely in C# and implements Apache Pulsar's [binary
protocol](https://pulsar.apache.org/docs/en/develop-binary-protocol/).
-
-## What's new?
-
-Have a look at the
[changelog](https://github.com/apache/pulsar-dotpulsar/blob/master/CHANGELOG.md).
-
-## Getting Started
-
-Let's take a look at a "Hello world" example, where we first produce a message
and then consume it. Note that the topic and subscription will be created if
they don't exist.
-
-First, we need a Pulsar setup. See [Pulsar
docs](https://pulsar.apache.org/docs/getting-started-home/) for how to set up a
local standalone Pulsar instance.
-
-Install the NuGet package
[DotPulsar](https://www.nuget.org/packages/DotPulsar/) and run the follow code
example:
-
-```csharp
-using DotPulsar;
-using DotPulsar.Extensions;
-
-const string myTopic = "persistent://public/default/mytopic";
-
-// connecting to pulsar://localhost:6650
-await using var client = PulsarClient.Builder().Build();
-
-// produce a message
-await using var producer =
client.NewProducer(Schema.String).Topic(myTopic).Create();
-await producer.Send("Hello World");
-
-// consume messages
-await using var consumer = client.NewConsumer(Schema.String)
- .SubscriptionName("MySubscription")
- .Topic(myTopic)
- .InitialPosition(SubscriptionInitialPosition.Earliest)
- .Create();
-
-await foreach (var message in consumer.Messages())
-{
- Console.WriteLine($"Received: {message.Value()}");
- await consumer.Acknowledge(message);
-}
-```
-
-For a more in-depth tour of the API, please visit the
[Wiki](https://github.com/apache/pulsar-dotpulsar/wiki).
-
-## Supported features
-
-- Service discovery
-- Automatic reconnect
-- TLS connections
-- Pulsar Proxy
-- Producer - send with custom metadata
-- Producer - send with event time, sequence id, and delayed message delivery
-- Producer - send with key and ordering key
-- Producer - partitioned topics
-- Consumer - subscription with initial position and priority level
-- Consumer - subscription types exclusive, shared, failover, and key shared
-- Consumer - receive and single + cumulative acknowledge
-- Consumer/Reader - seek on message-id and publish time
-- Consumer - unsubscribe
-- Consumer - compacted topics
-- Reader API
-- Read/Consume/Acknowledge batched messages
-- Telemetry
- - [Tracing](https://github.com/apache/pulsar-dotpulsar/wiki/Tracing)
- - [Metrics](https://github.com/apache/pulsar-dotpulsar/wiki/Metrics)
-- Authentication
- - TLS Authentication
- - JSON Web Token Authentication
- - Custom Authentication
-- [Message
compression](https://github.com/apache/pulsar-dotpulsar/wiki/Compression)
- - LZ4
- - ZLIB
- - ZSTD
- - SNAPPY
-- Schemas
- - Boolean
- - Bytes (using `byte[]` and `ReadOnlySequence<byte>`)
- - String (UTF-8, UTF-16, and US-ASCII)
- - INT8, INT16, INT32, and INT64
- - Float and Double
- - Time (using TimeSpan)
- - Timestamp and Date (using DateTime)
-
-For a horizontal comparison with more language-specific clients, see [Client
Feature Matrix](https://pulsar.apache.org/client-feature-matrix/).
-
-## Join Our Community
-
-Apache Pulsar has a [Slack instance](https://pulsar.apache.org/contact/), and
there you'll find us in the #dev-dotpulsar channel.
-
-## Versioning
-
-We use [SemVer](http://semver.org/) for versioning. For the versions
available, see the [tags on this
repository](https://github.com/apache/pulsar-dotpulsar/tags).
-
-## Contribution
-
-* **Daniel Blankensteiner** - *Initial work* - [Danske
Commodities](https://github.com/DanskeCommodities)
-
-Contributions are welcomed and greatly appreciated. See also the list of
[contributors](https://github.com/apache/pulsar-dotpulsar/contributors) who
participated in this project. Read the
[CONTRIBUTING](https://github.com/apache/pulsar-dotpulsar/blob/master/CONTRIBUTING.md)
guide for how to participate.
-
-If your contribution adds Pulsar features for C# clients, you need to update
both the [Pulsar docs](https://pulsar.apache.org/docs/client-libraries/) and
the [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/).
See [Contribution
Guide](https://pulsar.apache.org/contribute/site-intro/#pages) for more details.
-
-## License
-
-This project is licensed under [Apache License, Version
2.0](https://apache.org/licenses/LICENSE-2.0).
