[
https://issues.apache.org/jira/browse/SOLR-11646?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17360056#comment-17360056
]
Cassandra Targett commented on SOLR-11646:
------------------------------------------
The point of this issue originally wasn't to only update pages where
documenting an API was the focus, but to update _every_ example API call to
include the v2 version of it where one is possible.
But that was what, 4 years ago? I don't have time/ambition/energy to do this
work now or any time in a future I can foresee, so I'm OK leaving a few in v1
style without v2 and close this if you want to.
If there is API-documentation-energy available, I'd probably generally prefer
it be spent on battling out what to we intend to do with the v1 API style and
convert the remainders to v2 once that decision has been made.
> 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
> Components: documentation, v2 API
> Reporter: Cassandra Targett
> Assignee: Cassandra Targett
> Priority: Major
> Time Spent: 9h
> Remaining Estimate: 0h
>
> 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
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
