Skip to content

Commit

Permalink
Deploy website
Browse files Browse the repository at this point in the history
Deploy website version based on 305c306
  • Loading branch information
Docusaurus bot committed Dec 19, 2024
1 parent 7c9fde6 commit 2bbee2b
Show file tree
Hide file tree
Showing 10 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/admin.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
}
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Admin</h1></header><article><div><span><p>There is partial support for the Kafka admin API through <a href="/fs2-kafka/api/fs2/kafka/KafkaAdminClient.html">KafkaAdminClient</a>. Internally, this relies on the Java Kafka
<a href="https://kafka.apache.org/38/javadoc/?org/apache/kafka/clients/admin/AdminClient.html">AdminClient</a> and supports the same settings.</p>
<a href="https://kafka.apache.org/39/javadoc/?org/apache/kafka/clients/admin/AdminClient.html">AdminClient</a> and supports the same settings.</p>
<p>The following imports are assumed throughout this page.</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> cats.effect._
<span class="hljs-keyword">import</span> cats.syntax.all._
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
}
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Admin</h1></header><article><div><span><p>There is partial support for the Kafka admin API through <a href="/fs2-kafka/api/fs2/kafka/KafkaAdminClient.html">KafkaAdminClient</a>. Internally, this relies on the Java Kafka
<a href="https://kafka.apache.org/38/javadoc/?org/apache/kafka/clients/admin/AdminClient.html">AdminClient</a> and supports the same settings.</p>
<a href="https://kafka.apache.org/39/javadoc/?org/apache/kafka/clients/admin/AdminClient.html">AdminClient</a> and supports the same settings.</p>
<p>The following imports are assumed throughout this page.</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> cats.effect._
<span class="hljs-keyword">import</span> cats.syntax.all._
Expand Down
4 changes: 2 additions & 2 deletions docs/consumers.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Consumers</h1></header><article><div><span><p>Consumers support subscribing to topics, record streaming and deserialization, as well as miscellaneous utility functionality, such as seeking to offsets, or checking what the end offsets are for a topic. Consumers make use of the <a href="https://kafka.apache.org/38/javadoc/?org/apache/kafka/clients/consumer/KafkaConsumer.html">Java Kafka consumer</a>, which becomes especially important for <a href="#settings">settings</a>. For consumer implementation details, refer to the <a href="/fs2-kafka/docs/technical-details">technical details</a> section.</p>
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Consumers</h1></header><article><div><span><p>Consumers support subscribing to topics, record streaming and deserialization, as well as miscellaneous utility functionality, such as seeking to offsets, or checking what the end offsets are for a topic. Consumers make use of the <a href="https://kafka.apache.org/39/javadoc/?org/apache/kafka/clients/consumer/KafkaConsumer.html">Java Kafka consumer</a>, which becomes especially important for <a href="#settings">settings</a>. For consumer implementation details, refer to the <a href="/fs2-kafka/docs/technical-details">technical details</a> section.</p>
<p>The following imports are assumed throughout this page.</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> scala.concurrent.duration._

Expand Down Expand Up @@ -144,7 +144,7 @@ <h2><a class="anchor" aria-hidden="true" id="settings"></a><a href="#settings" a
.withBootstrapServers(<span class="hljs-string">"localhost:9092"</span>)
.withGroupId(<span class="hljs-string">"group"</span>)
</code></pre>
<p><a href="/fs2-kafka/api/fs2/kafka/ConsumerSettings.html"><code>ConsumerSettings</code></a> provides functions for configuring both the Java Kafka consumer and options specific to the library. If functions for configuring certain properties of the Java Kafka consumer is missing, we can instead use <code>withProperty</code> or <code>withProperties</code> together with constants from <a href="https://kafka.apache.org/38/javadoc/?org/apache/kafka/clients/consumer/ConsumerConfig.html"><code>ConsumerConfig</code></a>. Available properties for the Java Kafka consumer are described in the <a href="http://kafka.apache.org/documentation/#consumerconfigs">documentation</a>.</p>
<p><a href="/fs2-kafka/api/fs2/kafka/ConsumerSettings.html"><code>ConsumerSettings</code></a> provides functions for configuring both the Java Kafka consumer and options specific to the library. If functions for configuring certain properties of the Java Kafka consumer is missing, we can instead use <code>withProperty</code> or <code>withProperties</code> together with constants from <a href="https://kafka.apache.org/39/javadoc/?org/apache/kafka/clients/consumer/ConsumerConfig.html"><code>ConsumerConfig</code></a>. Available properties for the Java Kafka consumer are described in the <a href="http://kafka.apache.org/documentation/#consumerconfigs">documentation</a>.</p>
<h3><a class="anchor" aria-hidden="true" id="default-settings"></a><a href="#default-settings" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Default Settings</h3>
<p>The following Java Kafka consumer properties are overridden by default.</p>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/consumers/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Consumers</h1></header><article><div><span><p>Consumers support subscribing to topics, record streaming and deserialization, as well as miscellaneous utility functionality, such as seeking to offsets, or checking what the end offsets are for a topic. Consumers make use of the <a href="https://kafka.apache.org/38/javadoc/?org/apache/kafka/clients/consumer/KafkaConsumer.html">Java Kafka consumer</a>, which becomes especially important for <a href="#settings">settings</a>. For consumer implementation details, refer to the <a href="/fs2-kafka/docs/technical-details">technical details</a> section.</p>
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Consumers</h1></header><article><div><span><p>Consumers support subscribing to topics, record streaming and deserialization, as well as miscellaneous utility functionality, such as seeking to offsets, or checking what the end offsets are for a topic. Consumers make use of the <a href="https://kafka.apache.org/39/javadoc/?org/apache/kafka/clients/consumer/KafkaConsumer.html">Java Kafka consumer</a>, which becomes especially important for <a href="#settings">settings</a>. For consumer implementation details, refer to the <a href="/fs2-kafka/docs/technical-details">technical details</a> section.</p>
<p>The following imports are assumed throughout this page.</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> scala.concurrent.duration._

Expand Down Expand Up @@ -144,7 +144,7 @@ <h2><a class="anchor" aria-hidden="true" id="settings"></a><a href="#settings" a
.withBootstrapServers(<span class="hljs-string">"localhost:9092"</span>)
.withGroupId(<span class="hljs-string">"group"</span>)
</code></pre>
<p><a href="/fs2-kafka/api/fs2/kafka/ConsumerSettings.html"><code>ConsumerSettings</code></a> provides functions for configuring both the Java Kafka consumer and options specific to the library. If functions for configuring certain properties of the Java Kafka consumer is missing, we can instead use <code>withProperty</code> or <code>withProperties</code> together with constants from <a href="https://kafka.apache.org/38/javadoc/?org/apache/kafka/clients/consumer/ConsumerConfig.html"><code>ConsumerConfig</code></a>. Available properties for the Java Kafka consumer are described in the <a href="http://kafka.apache.org/documentation/#consumerconfigs">documentation</a>.</p>
<p><a href="/fs2-kafka/api/fs2/kafka/ConsumerSettings.html"><code>ConsumerSettings</code></a> provides functions for configuring both the Java Kafka consumer and options specific to the library. If functions for configuring certain properties of the Java Kafka consumer is missing, we can instead use <code>withProperty</code> or <code>withProperties</code> together with constants from <a href="https://kafka.apache.org/39/javadoc/?org/apache/kafka/clients/consumer/ConsumerConfig.html"><code>ConsumerConfig</code></a>. Available properties for the Java Kafka consumer are described in the <a href="http://kafka.apache.org/documentation/#consumerconfigs">documentation</a>.</p>
<h3><a class="anchor" aria-hidden="true" id="default-settings"></a><a href="#default-settings" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Default Settings</h3>
<p>The following Java Kafka consumer properties are overridden by default.</p>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h3><a class="anchor" aria-hidden="true" id="snapshot-releases"></a><a href="#sn
<p>To use the latest snapshot release, add the following lines to your <code>build.sbt</code> file.</p>
<pre><code class="hljs css language-scala">resolvers += <span class="hljs-type">Resolver</span>.sonatypeRepo(<span class="hljs-string">"snapshots"</span>)

libraryDependencies += <span class="hljs-string">"com.github.fd4s"</span> %% <span class="hljs-string">"fs2-kafka"</span> % <span class="hljs-string">"3.6.0-3-4be5a54-SNAPSHOT"</span>
libraryDependencies += <span class="hljs-string">"com.github.fd4s"</span> %% <span class="hljs-string">"fs2-kafka"</span> % <span class="hljs-string">"3.6.0-4-305c306-SNAPSHOT"</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="dependencies"></a><a href="#dependencies" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Dependencies</h2>
<p>Refer to the table below for dependencies and version support across modules.</p>
Expand All @@ -93,7 +93,7 @@ <h2><a class="anchor" aria-hidden="true" id="dependencies"></a><a href="#depende
<tr><th>Module</th><th>Dependencies</th><th>Scala</th></tr>
</thead>
<tbody>
<tr><td><code>fs2-kafka</code></td><td><a href="https://github.com/functional-streams-for-scala/fs2">FS2 3.11.0</a>, <a href="https://github.com/apache/kafka">Apache Kafka Client 3.8.1</a></td><td>Scala 2.12, 2.13 and 3.3</td></tr>
<tr><td><code>fs2-kafka</code></td><td><a href="https://github.com/functional-streams-for-scala/fs2">FS2 3.11.0</a>, <a href="https://github.com/apache/kafka">Apache Kafka Client 3.9.0</a></td><td>Scala 2.12, 2.13 and 3.3</td></tr>
<tr><td><code>fs2-kafka-vulcan</code></td><td><a href="https://github.com/fd4s/vulcan">Vulcan 1.11.1</a>, <a href="https://github.com/confluentinc/schema-registry">Confluent Kafka Avro Serializer 7.7.2</a></td><td>Scala 2.12, 2.13 and 3.3</td></tr>
</tbody>
</table>
Expand Down
4 changes: 2 additions & 2 deletions docs/overview/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h3><a class="anchor" aria-hidden="true" id="snapshot-releases"></a><a href="#sn
<p>To use the latest snapshot release, add the following lines to your <code>build.sbt</code> file.</p>
<pre><code class="hljs css language-scala">resolvers += <span class="hljs-type">Resolver</span>.sonatypeRepo(<span class="hljs-string">"snapshots"</span>)

libraryDependencies += <span class="hljs-string">"com.github.fd4s"</span> %% <span class="hljs-string">"fs2-kafka"</span> % <span class="hljs-string">"3.6.0-3-4be5a54-SNAPSHOT"</span>
libraryDependencies += <span class="hljs-string">"com.github.fd4s"</span> %% <span class="hljs-string">"fs2-kafka"</span> % <span class="hljs-string">"3.6.0-4-305c306-SNAPSHOT"</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="dependencies"></a><a href="#dependencies" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Dependencies</h2>
<p>Refer to the table below for dependencies and version support across modules.</p>
Expand All @@ -93,7 +93,7 @@ <h2><a class="anchor" aria-hidden="true" id="dependencies"></a><a href="#depende
<tr><th>Module</th><th>Dependencies</th><th>Scala</th></tr>
</thead>
<tbody>
<tr><td><code>fs2-kafka</code></td><td><a href="https://github.com/functional-streams-for-scala/fs2">FS2 3.11.0</a>, <a href="https://github.com/apache/kafka">Apache Kafka Client 3.8.1</a></td><td>Scala 2.12, 2.13 and 3.3</td></tr>
<tr><td><code>fs2-kafka</code></td><td><a href="https://github.com/functional-streams-for-scala/fs2">FS2 3.11.0</a>, <a href="https://github.com/apache/kafka">Apache Kafka Client 3.9.0</a></td><td>Scala 2.12, 2.13 and 3.3</td></tr>
<tr><td><code>fs2-kafka-vulcan</code></td><td><a href="https://github.com/fd4s/vulcan">Vulcan 1.11.1</a>, <a href="https://github.com/confluentinc/schema-registry">Confluent Kafka Avro Serializer 7.7.2</a></td><td>Scala 2.12, 2.13 and 3.3</td></tr>
</tbody>
</table>
Expand Down
4 changes: 2 additions & 2 deletions docs/producers.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Producers</h1></header><article><div><span><p>Producers support publishing of records. Producers make use of the <a href="https://kafka.apache.org/38/javadoc/?org/apache/kafka/clients/producer/KafkaProducer.html">Java Kafka producer</a>, which becomes especially important for <a href="#settings">settings</a>.</p>
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Producers</h1></header><article><div><span><p>Producers support publishing of records. Producers make use of the <a href="https://kafka.apache.org/39/javadoc/?org/apache/kafka/clients/producer/KafkaProducer.html">Java Kafka producer</a>, which becomes especially important for <a href="#settings">settings</a>.</p>
<p>The following imports are assumed throughout this page.</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> scala.concurrent.duration._

Expand Down Expand Up @@ -137,7 +137,7 @@ <h2><a class="anchor" aria-hidden="true" id="settings"></a><a href="#settings" a
valueSerializer = <span class="hljs-type">Serializer</span>[<span class="hljs-type">IO</span>, <span class="hljs-type">String</span>]
).withBootstrapServers(<span class="hljs-string">"localhost:9092"</span>)
</code></pre>
<p><a href="/fs2-kafka/api/fs2/kafka/ProducerSettings.html"><code>ProducerSettings</code></a> provides functions for configuring both the Java Kafka producer and options specific to the library. If functions for configuring certain properties of the Java Kafka producer is missing, we can instead use <code>withProperty</code> or <code>withProperties</code> together with constants from <a href="https://kafka.apache.org/38/javadoc/?org/apache/kafka/clients/producer/ProducerConfig.html"><code>ProducerConfig</code></a>. Available properties for the Java Kafka producer are described in the <a href="http://kafka.apache.org/documentation/#producerconfigs">documentation</a>.</p>
<p><a href="/fs2-kafka/api/fs2/kafka/ProducerSettings.html"><code>ProducerSettings</code></a> provides functions for configuring both the Java Kafka producer and options specific to the library. If functions for configuring certain properties of the Java Kafka producer is missing, we can instead use <code>withProperty</code> or <code>withProperties</code> together with constants from <a href="https://kafka.apache.org/39/javadoc/?org/apache/kafka/clients/producer/ProducerConfig.html"><code>ProducerConfig</code></a>. Available properties for the Java Kafka producer are described in the <a href="http://kafka.apache.org/documentation/#producerconfigs">documentation</a>.</p>
<h3><a class="anchor" aria-hidden="true" id="default-settings"></a><a href="#default-settings" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Default Settings</h3>
<p>The following Java Kafka producer properties are overridden by default.</p>
<ul>
Expand Down
Loading

0 comments on commit 2bbee2b

Please sign in to comment.