Aiven-Open / Aiven-Open/cloud-storage-connectors-for-apache-kafka

Add configuration documentation for all connectors.

Open
#514 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Java
Stars
58
Forks
39
Avg merge
2d 10h
Merged PRs (30d)
5

Description

The S3 Source connector has generated documentation on the project web site. This improvement is to add documentation for all the connectors.

This involves

- Adding additional targets to the `build.gradle.kts` files. See the S3 Source build.gradle.kts section labeled 'Documentation building section'. Also look for `compileOnly(project(":site"))` and the 2 entries below it in the "dependencies" section.
- Adding `src/templates/configData.md.vm` and `src/templates/configData.yml.vm`. There are examples in the S3 Source directories. Class names, file names, and directories for the targets will need to be edited.
- Adding a `` line where the href is the module name (e.g. s3-sink-connector) and the file name from the `configData.md.vm` file with an "html" extension rather than the "md" extension (e.g. "S3SinkConfig.html").

Run
```
./gradlew :site:build
./gradlew :copySiteAssets
./gradlew createSite
./gradlew :site:build :copySiteAssets createSite javadoc
./gradlew populateSite
```

**Do not run the above all on one line** as it won't work correctly.

Test the new document by loading `site/target/site/index.html` and verifying the configuration documentation is listed and loads.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.