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

SOLR-15730: Document SolrJ opt-in for 10x #1021

Merged
merged 4 commits into from Sep 22, 2022

Conversation

dsmiley
Copy link
Contributor

@dsmiley dsmiley commented Sep 17, 2022

See https://issues.apache.org/jira/browse/SOLR-15730?focusedCommentId=17603208&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-17603208

Added "Major changes in Solr 10".
Moved the "Upgrading 9.1" section to the page it should be on.

Someone please do a sanity check on the pages by rendering them locally. I believe this is via gradlew buildLocalSite. I can't get major-changes-in-solr-10.adoc to show up in the navigation; it's an orphaned page.

Added "Major changes in Solr 10".
Moved the "Upgrading 9.1" section to the page it should be on.
Copy link
Contributor

@janhoy janhoy left a comment

Choose a reason for hiding this comment

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

One comment for 9.1 wording.

@@ -68,6 +68,11 @@ Due to changes in Lucene 9, that isn't possible any more.
=== Querying and Indexing
* Added Lucene91HnswVectorsFormat codec for DenseVectorField. In order to use the new codec, reindex is necessary.

=== SolrJ
SolrJ is beginning to be split up. If you use ZooKeeper coordinates to create a `CloudSolrClient`, you will need to add a dependency on `solrj-zookeeper`.
Copy link
Contributor

Choose a reason for hiding this comment

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

As I understand, this will be a transitive dependency in Solr 9.1, so this text should say that no changes are needed as long as you enable automatic dependency resolution in maven/gradle.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure.

SolrJ is beginning to be split up. If you use ZooKeeper coordinates to create a CloudSolrClient, you will need to add a dependency on solrj-zookeeper. If you use SolrJ's Maven POM to depend on SolrJ, then this should happen automatically through transitive resolution.

@HoustonPutman
Copy link
Contributor

Wait I'm confused, can you clear this up @janhoy ?

I thought that the solr-upgrade-notes.adoc was supposed to have the current major versions minor releases. Then that page will be migrated to major-changes-in-solr-10.adoc whenever Solr 10 is cut. Am I missing something?

@janhoy
Copy link
Contributor

janhoy commented Sep 21, 2022

Wait I'm confused, can you clear this up @janhoy ?

I thought that the solr-upgrade-notes.adoc was supposed to have the current major versions minor releases. Then that page will be migrated to major-changes-in-solr-10.adoc whenever Solr 10 is cut. Am I missing something?

You are right, and I thought about it too. But then it is a bit confusing too. You proposed to change how we do all this, didn't you? Perhaps we shold do that soon?

@dsmiley
Copy link
Contributor Author

dsmiley commented Sep 21, 2022

Where we put notes on this has been confusing! I feel like it needs it's own developer documentation how-to!

@HoustonPutman
Copy link
Contributor

Right now our docs are structured such that we are expecting users to upgrade from an outdated minor version to the x.0 release of the next version. To me it would be clearer to have it like David is doing, but then we kind of need to either change the page names (which is fine because we are on antora now) so that major-changes-in-solr-9.adoc forwards requests too solr-8-upgrade-notes.adoc and have all 8.0-8.11 notes there. So that the anchor to 9.0 in that current page is not broken, we can have a small section at the end that links to solr-9-upgrade-notes.adoc#9.0 or something like that.

At this point we won't need to do anything for a major release, and links stay consistent even when the major version is cut.
We can also trust people to look at all of the versions that they are skipping, even if it's on a different page.

I can try to hack something together tomorrow if y'all want to see it to completion after that.

@janhoy
Copy link
Contributor

janhoy commented Sep 21, 2022

Cassandra documented partly how it's done here https://issues.apache.org/jira/browse/SOLR-15901
I think there used to be some meta-docs about this earlier too but I cannot find it now. We should probably establish a dev-docs document about how to maintain the ref-guide.

I'm all for a restructure on this. Then the solr-10-upgrade-notes will talk about what's new in Solr 10 and 10.x, and it will clearly state that users upgrading from earlier 9.x versions or even from 8.x will need to consult those pages, which seems logical.

@dsmiley
Copy link
Contributor Author

dsmiley commented Sep 21, 2022

The discussions are good but I think I can merge this finally, and back-port some aspects to branch_9x?

@HoustonPutman
Copy link
Contributor

Go ahead and merge, we can fix these things separately

@dsmiley dsmiley merged commit c2a9626 into apache:main Sep 22, 2022
@dsmiley dsmiley deleted the solrj-modules-10-docs branch September 22, 2022 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants