Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update configuration and running locally docs #6

Merged
merged 3 commits into from
Jun 16, 2021
Merged

Update configuration and running locally docs #6

merged 3 commits into from
Jun 16, 2021

Conversation

lmars
Copy link
Member

@lmars lmars commented Jun 12, 2021

This updates the README to have separate "Installation", "Configuration" and "Running locally" sections, adds a commented configuration file, and enables the kafka-connect-maven-plugin to output a ZIP file that can be installed into Kafka Connect clusters.

Closes #8

Signed-off-by: Lewis Marshall <lewis.marshall@ably.com>
@lmars lmars requested a review from Matt-Esch June 12, 2021 15:21
@github-actions github-actions bot temporarily deployed to staging/pull/6/kafka-connect-ably June 14, 2021 12:48 Inactive
Signed-off-by: Lewis Marshall <lewis.marshall@ably.com>
@github-actions github-actions bot temporarily deployed to staging/pull/6/kafka-connect-ably June 14, 2021 12:51 Inactive
@lmars
Copy link
Member Author

lmars commented Jun 14, 2021

@lmars lmars force-pushed the update-docs branch 5 times, most recently from 1bb5434 to 5617b06 Compare June 14, 2021 16:03
@github-actions github-actions bot temporarily deployed to staging/pull/6/kafka-connect-ably June 14, 2021 16:05 Inactive
Signed-off-by: Lewis Marshall <lewis.marshall@ably.com>
@lmars
Copy link
Member Author

lmars commented Jun 14, 2021

So I realised that some docs are rendered out into the target/docs directory by the connect-utils repo (see templates here), but they are Sphinx source files so I've added a GitHub action to render them to HTML and also upload those (see fb941a1), which can now be seen when clicking the "View deployment" button, e.g.:

https://sdk.ably.com/builds/ably/kafka-connect-ably/pull/6/

The nice thing about this is the auto-generated config docs:

https://sdk.ably.com/builds/ably/kafka-connect-ably/pull/6/sinks/ChannelSinkConnector.html

@paddybyers
Copy link
Member

Why is this all in the io.ably package? It should be com.ably

@lmars
Copy link
Member Author

lmars commented Jun 15, 2021

Why is this all in the io.ably package? It should be com.ably

I assumed there was some historic reason (e.g. we're registered under io.ably in some packaging system), if that's not the case then yes we should change it. Tracked in https://ably.atlassian.net/browse/INT-8

@paddybyers
Copy link
Member

e.g. we're registered under io.ably in some packaging system

Historically that was true for Maven Central, but nonetheless we're now building stuff in com.ably (eg https://github.com/ably/ably-asset-tracking-android)

Base automatically changed from tests to main June 15, 2021 19:12
Copy link
Contributor

@Matt-Esch Matt-Esch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 LGTM

@lmars lmars merged commit a6dab3a into main Jun 16, 2021
@lmars lmars deleted the update-docs branch June 16, 2021 07:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Update configuration and running locally docs
3 participants