rhauch commented on a change in pull request #11908:
URL: https://github.com/apache/kafka/pull/11908#discussion_r835615520
##########
File path: docs/quickstart.html
##########
@@ -173,7 +173,11 @@ <h4 class="anchor-heading">
</p>
<p>
- First, we'll start by creating some seed data to test with:
+ First, make sure to add <code
class="language-bash">connect-file-{{fullDotVersion}}.jar</code> to the
<code>plugin.path</code> property in the Connect worker's configuration (see <a
href="#connectconfigs_plugin.path">plugin.path</a> for examples).
+ </p>
Review comment:
Will users that are trying this for the first time understand what this
means, or will this be enough of a barrier to cause them to abandon the
quickstart? I'm not sure, but it might be worth to be more explicit here.
First, since this is a quickstart I think it's okay to duplicate some
information here just so that users don't have to go elsewhere to learn what
they need to do to run the quickstart.
Second, the referenced plugin.path configuration section says (emphasis
mine):
> The list should consist of top level _directories_ that include any
combination of ...
And, to run the quickstarts we want them to add the _path to that JAR file_
to the `plugin.path` configuration property, not add the _path to the `lib/`
directory_ that contains the `connect-file-<version>.JAR` file, as the
referenced documentation suggests to do.
So, I suggest we be much more explicit here, and say something like:
```suggestion
First, instruct Connect to use the example file system
connectors by editing the configuration for the Connect standalone worker to
changing the following line from:
</p>
<pre class="brush: bash;">
#plugin.path=</pre>
to:
</p>
<pre class="brush: bash;">
plugin.path=lib/connect-file-{{fullDotVersion}}.jar</pre>
```
We could make this a little easier if we changed the
`connect-standalone.properties` and `connect-distributed.properties` files to
add a few lines to the existing commented out section, so that all a user has
to do is uncomment one line. For example:
```
...
# Set to a list of filesystem paths separated by commas (,) to enable class
loading isolation for plugins
# (connectors, converters, transformations). The list should consist of top
level directories that include
# any combination of:
# a) directories immediately containing jars with plugins and their
dependencies
# b) uber-jars with plugins and their dependencies
# c) directories immediately containing the package directory structure of
classes of plugins and their dependencies
# Note: symlinks will be followed to discover dependencies or plugins.
# Examples:
#
plugin.path=/usr/local/share/java,/usr/local/share/kafka/plugins,/opt/connectors,
#
# To run the quickstart that just uses the example file system connectors,
uncomment this line:
# plugin.path=lib/connect-file-<version>.jar,
#
#plugin.path=
```
These are comments, and I think we can improve the comments without a KIP,
especially since with this PR we're trying to limit the impact on the
quickstarts.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
