Skip to content

Commit 87b6bfd

Browse files
authored
docs: fix heading and contribution link (#192)
* fix: doc headings of offsets * fix: contribution guide link in readme
1 parent b052605 commit 87b6bfd

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ $ ./gradlew clean
9898

9999
Development of Firehose happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Firehose.
100100

101-
Read our [contributing guide](docs/contribute/contribution.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Firehose.
101+
Read our [contributing guide](docs/docs/contribute/contribution.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Firehose.
102102

103103
To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/odpf/firehose/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started.
104104

docs/docs/concepts/offsets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ To use offset manager:
1212
* `setCommittable(Object batch)` to set the committable flag to be true.
1313
* `getCommittableOffset()` returns the largest offset that can be committed.
1414

15-
##Implementation
16-
###Data Structures
15+
## Implementation
16+
### Data Structures
1717
* OffsetNode: A combination of topic, partition and the offset.
1818
* toBeCommittableBatchOffsets: A map of batch-keys and a set of OffsetNodes.
1919
* sortedOffsets: A map of topic-partition to a sorted list of OffsetNode.

0 commit comments

Comments
 (0)