Skip to content

Commit a5e4ed5

Browse files
committed
Examples in documentation
1 parent 2cfe63e commit a5e4ed5

File tree

3 files changed

+15
-1
lines changed

3 files changed

+15
-1
lines changed

site/docs/data/menu.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,8 @@ options:
2929
- title: Statistics
3030
url: docs/statistics
3131

32+
- title: Examples
33+
url: docs/examples
34+
3235
- title: Migration from 1.x
3336
url: docs/migration

site/docs/docs/examples.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
layout: docs
3+
title: Examples
4+
permalink: docs/examples/
5+
---
6+
7+
# Examples
8+
9+
Please check [examples](https://github.com/mjakubowski84/parquet4s/blob/master/examples) where you can find simple code covering basics for core, akka and fs2 modules.
10+
11+
Moreover, examples contain two simple applications comprising Akka Streams or FS2 and Kafka. They show how you can write partitioned Parquet files with data coming from an indefinite stream.

site/docs/docs/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ As it is based on Hadoop Client then you can connect to any Hadoop-compatible st
2121

2222
Integrations for [Akka Streams](https://doc.akka.io/docs/akka/current/stream/index.html) and [FS2](https://fs2.io/).
2323

24-
Released for Scala 2.12.x, 2.13.x and 3.0.x.
24+
Released for Scala 2.12.x, 2.13.x and 3.0.x.\
2525
Akka module is available for Scala 2.12.x and 2.13.x.

0 commit comments

Comments
 (0)