Skip to content

Commit

Permalink
convert readme to adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
d-rk committed Jan 18, 2024
1 parent df74d9d commit ba09560
Show file tree
Hide file tree
Showing 3 changed files with 331 additions and 256 deletions.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ Please delete options that are not relevant.
## Documentation

- [ ] the change is mentioned in the `## [Unreleased]` section of `CHANGELOG.md`
- [ ] the configuration yaml was changed and the example config in `README.md` was updated
- [ ] a usage example was added to `README.md`
- [ ] the configuration yaml was changed and the example config in `README.adoc` was updated
- [ ] a usage example was added to `README.adoc`
- [ ] tests for the changes have been implemented (see: [Testing your changes](https://github.com/deviceinsight/kafkactl/blob/main/.github/contributing.md#testing-your-changes))
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ of `plaintext`.
## 1.11.0 - 2020-08-07

### Added
- direct support for kafka clusters [running in kubernetes](https://github.com/deviceinsight/kafkactl/blob/main/README.md#running-in-kubernetes)
- direct support for kafka clusters [running in kubernetes](https://github.com/deviceinsight/kafkactl/blob/main/README.adoc#running-in-kubernetes)
- `attach` command to get a bash into kafkactl pod when running in kubernetes

## 1.10.0 - 2020-08-03
Expand Down Expand Up @@ -352,7 +352,7 @@ of `plaintext`.
## 1.2.0 - 2019-05-24

### Added
- Additional config file locations added. See README.md for details
- Additional config file locations added. See README.adoc for details
- Added `offset` parameter to `consume`
- Support for basic auto completion in fish shell
- Add 'config view` command, to view current config
Expand Down
Loading

0 comments on commit ba09560

Please sign in to comment.