[jira] [Updated] (SOLR-14383) Fix indexing-nested-documents.adoc XML/JSON examples to be accurate, consistent, and clear

["Chris M. Hostetter (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/SOLR-14383?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Chris M. Hostetter updated SOLR-14383:
--------------------------------------
    Attachment: SOLR-14383.patch
      Assignee: Chris M. Hostetter
        Status: Open  (was: Open)

I've started down the road to completely revamping this page (and the assocaited sections of other pages that link in/out) with the goal of having a good consistent example (in both json, xml, and solrj) showing (deeply) nested docs that have "type" info, and pushing the older style "anonymous" nested docs out of the main example and into it's own section at the bottom of the page -- i can't think of any practical reason to "showcase" sending hierarchical documents in both formats _in the same request_.

there are still a lot of nocommits about stuff that needs more cleanup (notably: the xml/solrj example blocks are just placeholders until i polish up the query sections to be sure i don't need/want to change the example docs to make the query examples more interestion) but 
I'd appreciate some feedback from folks who have worked on all of this stuff recently -- ie: [~dsmiley], [~moshebla], [~mkhl] -- as to wether they think this is moving in the right direction ... before i go too deep down the rabbit hole.

> Fix indexing-nested-documents.adoc XML/JSON examples to be accurate, consistent, and clear
> ------------------------------------------------------------------------------------------
>
>                 Key: SOLR-14383
>                 URL: https://issues.apache.org/jira/browse/SOLR-14383
>             Project: Solr
>          Issue Type: Sub-task
>            Reporter: Chris M. Hostetter
>            Assignee: Chris M. Hostetter
>            Priority: Major
>         Attachments: SOLR-14383.patch
>
>
> As reported on solr-user@lucene by Peter Pimley...
> {noformat}
> The page "Indexing Nested Documents" has an XML example showing two
> different ways of adding nested documents:
> https://lucene.apache.org/solr/guide/8_5/indexing-nested-documents.html#xml-examples
> The text says:
>   "It illustrates two styles of adding child documents: the first is
> associated via a field "comment" (preferred), and the second is done
> in the classic way now referred to as an "anonymous" or "unlabelled"
> child document."
> However in the XML directly below there is no field named "comment".
> There is one named "content" and another named "comments" (plural),
> but no field named "comment".  In fact, looking at the Json example
> immediately below, I wonder if the XML element currently named
> "content" should be named "comments", and what is currently marked
> "comments" should be "content"?
> Secondly, in the Json example it says:
>   "The labelled relationship here is one child document but could have
> been wrapped in array brackets."
> However in the actual Json, the parent document (ID=1) with a labelled
> relationship has two child documents (IDs 2 and 3), and they are
> already in array brackets.
> {noformat}
> * The 2 examples (XML and JSON) should be updated to contains *structurally* identical content, (ie: same number of documents, with same field values, and same hierarchical relationships) to focus on demonstrating the syntax differences (ie: things like the special {{\_childDocuments\_}} key in json)
> * The paragraphs describing the examples should be updated to:
> ** refer to the correct field names -- since both "comments" and "contents" fields exist in the examples, it's impossible for novice users to even udnerstand where th "typo" might be in the descriptions (I'm pretty knowledgeable about Solr and even i'm second guessing myself as to what the intent in these paragraphs are)
> ** refer to documents by {{"id"}} value, not just descriptors like "first" and "second" 
> * it might be worth considering rewriting this section to use "callouts": https://asciidoctor.org/docs/user-manual/#callouts -- similar to how we use them in other sections like this: https://lucene.apache.org/solr/guide/8_5/uploading-data-with-index-handlers.html#sending-json-update-commands



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org