Skip to content

Commit 3ae34d7

Browse files
committed
Updated README to point to github page rather than raw markup. Updated docs baseUrl
1 parent a187389 commit 3ae34d7

File tree

2 files changed

+30
-18
lines changed

2 files changed

+30
-18
lines changed

README.md

+28-16
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ kstream.merge(ktable).filter(/* .. */).map(/* .. */).reduce(/* .. */).to("output
2424
2525
## API Overview
2626

27-
* [Quick Start](website/docs/quick-start.md)
28-
* [Message 'to' and 'from' Apache Kafka](website/docs/handling-message-schemas.md)
29-
* [API Info](website/docs/classDocs.md)
30-
* [Documentation](https://nodefluent.github.io/kafka-streams/jsdoc/)
31-
* [Operator descriptions](website/docs/most-api.md)
27+
* [Quick Start](https://nodefluent.github.io/kafka-streams/docs/)
28+
* [Message 'to' and 'from' Apache Kafka](https://nodefluent.github.io/kafka-streams/docs/handlingMessageSchemas)
29+
* [API Info](https://nodefluent.github.io/kafka-streams/docs/classDoc)
30+
* [Documentation](https://nodefluent.github.io/kafka-streams/)
31+
* [Operator descriptions](https://nodefluent.github.io/kafka-streams/docs/mostAPI)
3232
* [Examples](https://github.com/nodefluent/kafka-streams/tree/master/examples)
33-
* [Native Client](website/docs/native.md) | [SSL, SASL, Kerberos](website/docs/ssl-sasl.md)
33+
* [Native Client](https://nodefluent.github.io/kafka-streams/docs/native) | [SSL, SASL, Kerberos](https://nodefluent.github.io/kafka-streams/docs/sslSasl)
3434

3535
## You might also like
3636

@@ -40,16 +40,28 @@ kstream.merge(ktable).filter(/* .. */).map(/* .. */).reduce(/* .. */).to("output
4040

4141
## README Overview
4242

43-
* [Prerequisites](#prerequisites)
44-
* [Aim of this Library](#aim-of-this-library)
45-
* [Description](#description)
46-
* [Port Progress Overview](#port-progress-overview)
47-
* [Operator Implementations](#operator-implementations)
48-
* [Additional Operators](#additional-operators)
49-
* [Stream Action Implementations](#stream-action-implementations)
50-
* [Join Operators Status](#join-operations)
51-
* [Window Operations](#window-operations)
52-
* [FAQ - More](#more)
43+
- [node-kafka-streams](#node-kafka-streams)
44+
- [API Overview](#api-overview)
45+
- [You might also like](#you-might-also-like)
46+
- [README Overview](#readme-overview)
47+
- [Prerequisites](#prerequisites)
48+
- [A note on native mode](#a-note-on-native-mode)
49+
- [Aim of this Library](#aim-of-this-library)
50+
- [Description](#description)
51+
- [Port Progress Overview](#port-progress-overview)
52+
- [Operator Implementations](#operator-implementations)
53+
- [Additional Operators](#additional-operators)
54+
- [Stream Action Implementations](#stream-action-implementations)
55+
- [Join Operations](#join-operations)
56+
- [KStream Status](#kstream-status)
57+
- [KTable Status](#ktable-status)
58+
- [KTable <-> KStream Status](#ktable---kstream-status)
59+
- [Window Operations](#window-operations)
60+
- [KStream](#kstream)
61+
- [More](#more)
62+
- [Can I use this library yet?](#can-i-use-this-library-yet)
63+
- [Are we ready for production yet?](#are-we-ready-for-production-yet)
64+
- [Even More](#even-more)
5365

5466
## Prerequisites
5567

website/docusaurus.config.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module.exports = {
22
title: 'Kafka streams',
33
tagline: 'equivalent to kafka-streams 🐙 for nodejs ✨🐢🚀✨',
44
url: 'https://nodefluent.github.io',
5-
baseUrl: '/',
5+
baseUrl: '/kafka-streams/',
66
onBrokenLinks: 'throw',
77
favicon: '🐙',
88
organizationName: 'nodefluent', // Usually your GitHub org/user name.
@@ -49,7 +49,7 @@ module.exports = {
4949
homePageId: 'quickStart',
5050
sidebarPath: require.resolve('./sidebars.js'),
5151
editUrl:
52-
'https://github.com/nodefluent/kafka-streams/website/',
52+
'https://github.com/nodefluent/kafka-streams/tree/master/website/',
5353
},
5454
theme: {
5555
customCss: require.resolve('./src/css/custom.css'),

0 commit comments

Comments
 (0)