SOLR-18462: Feature JSON before XML in indexing-with-update-handlers - #4926
Open
serhiy-bzhezytskyy wants to merge 1 commit into
Open
serhiy-bzhezytskyy wants to merge 1 commit into
serhiy-bzhezytskyy wants to merge 1 commit into
Conversation
The page covered XML Formatted Index Updates before JSON Formatted Index Updates, despite JSON being the more common choice today. Moved the JSON section ahead of XML, leaving CSV last; no content was changed, only reordered.
Contributor
Author
|
@epugh tagging you since this is under SOLR-18459/SOLR-18462, which you filed. |
github-actions
Bot
added
the
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
https://issues.apache.org/jira/browse/SOLR-18462
Description
"Our docs should be featuring JSON then XML, not XML then JSON." Checked every page with both a JSON and an XML section or tab: the 5 existing
JSON::/XML::tab examples (inindexing-nested-documents.adocanddense-vector-search.adoc) already put JSON first. One page didn't:indexing-with-update-handlers.adoccovers "XML Formatted Index Updates" as a whole top-level section before "JSON Formatted Index Updates", with "CSV Formatted Index Updates" last.Solution
Moved the JSON section ahead of the XML section (CSV stays last). No content was changed, only relocated — the diff is exactly 150 insertions and 150 deletions. Checked first that neither section contains order-dependent prose ("as we saw above", "the following section", etc.) that would break across the move; found none.
xrefanchors are heading-derived, not position-derived, so no cross-reference elsewhere in the guide is affected.Tests
Ran
./gradlew :solr:solr-ref-guide:buildLocalAntoraSiteand:checkSiteLinksbefore and after: same 6 pre-existing warnings (unrelated, tracked in #4922/SOLR-18464), no new ones, no broken links.AI-assisted (Claude Sonnet 5).