malliaridis commented on code in PR #2808:
URL: https://github.com/apache/solr/pull/2808#discussion_r1820628491
##########
solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-10.adoc:
##########
@@ -35,6 +35,14 @@ Minimum Java version for Solr 10.x is Java 21.
The Solr CLI has gone through some significant renovations to reduce technical
debt, and now functions more consistently and predictably. Most notably, CLI
commands now use unix-style options, e.g. `--help` instead of `-help`.
Users are urged to review all use of the `bin/solr` command, such as in
scripts and documentation, to ensure that the correct options are being used.
+Some key changes that you may run into are:
+
+ * Commands that interact with Solr now all use `--solr-url` (or `-s`) plus a
`--name` (or `-c`) to specify the Solr to interact with.
+ * You may use `--zk-host` (or `-z`) in place of the `--solr-url` option to
lookup the Solr host.
+ * Basic Authentication support has been added to bin/solr via the
`--credentials` (or `-u`) option.
+
+To learn about specific changes to each CLI tool use the `--help` option.
Review Comment:
The `--help` does not point out the changes, but lists only the new
features. So eventually we could say something like
```suggestion
To learn about the updated options in each CLI tool, use the `--help` option
or look up the tool in the documentation.
```
##########
solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-10.adoc:
##########
@@ -35,6 +35,14 @@ Minimum Java version for Solr 10.x is Java 21.
The Solr CLI has gone through some significant renovations to reduce technical
debt, and now functions more consistently and predictably. Most notably, CLI
commands now use unix-style options, e.g. `--help` instead of `-help`.
Users are urged to review all use of the `bin/solr` command, such as in
scripts and documentation, to ensure that the correct options are being used.
+Some key changes that you may run into are:
+
+ * Commands that interact with Solr now all use `--solr-url` (or `-s`) plus a
`--name` (or `-c`) to specify the Solr to interact with.
+ * You may use `--zk-host` (or `-z`) in place of the `--solr-url` option to
lookup the Solr host.
+ * Basic Authentication support has been added to bin/solr via the
`--credentials` (or `-u`) option.
+
Review Comment:
Believing that we will also remove the deprecated options in 10, this could
also be mentioned:
```suggestion
* Some short and single-letter options have been removed to avoid conflicts
or in favor to other options.
```
--
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: issues-unsubscr...@solr.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org
