Cassandra Targett commented on SOLR-11646:

bq. Was there a particular reason you chose to keep v1 as the default?

Heh, no reason beyond how my brain works when organizing things: V1 was first 
so it goes first, V2 came later so it goes second. I don't recall how long I 
thought about it, though, so probably not very long.

Your point is well taken, though - most users will likely use the first example 
they see, and if we want to nudge users to use the new APIs then the way it is 
now still obscures them somewhat. Might be worth changing, I'll think about it 
some more when I get back to this (hopefully soon-ish, but I left the hardest 
APIs for last so I'm dragging my feet a bit on it).

> Ref Guide: Update API examples to include v2 style examples
> -----------------------------------------------------------
>                 Key: SOLR-11646
>                 URL: https://issues.apache.org/jira/browse/SOLR-11646
>             Project: Solr
>          Issue Type: Improvement
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation, v2 API
>            Reporter: Cassandra Targett
>            Assignee: Cassandra Targett
>            Priority: Major
> The Ref Guide currently only has a single page with what might be generously 
> called an overview of the v2 API added in 6.5 
> (https://lucene.apache.org/solr/guide/v2-api.html) but most of the actual 
> APIs that support the v2 approach do not show an example of using it with the 
> v2 style. A few v2-style APIs are already used as examples, but there's 
> nothing consistent.
> With this issue I'll add API input/output examples throughout the Guide. Just 
> in terms of process, my intention is to have a series of commits to the pages 
> as I work through them so we make incremental progress. I'll start by adding 
> a list of pages/APIs to this issue so the scope of the work is clear.
> Once this is done we can figure out what to do with the V2 API page itself - 
> perhaps it gets archived and replaced with another page that describes Solr's 
> APIs overall; perhaps by then we figure out something else to do with it.

This message was sent by Atlassian JIRA

To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org

Reply via email to