You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Jason Gerlowski (JIRA)" <ji...@apache.org> on 2018/03/06 23:31:00 UTC
[jira] [Comment Edited] (SOLR-11646) Ref Guide: Update API examples
to include v2 style examples
[ https://issues.apache.org/jira/browse/SOLR-11646?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16388693#comment-16388693 ]
Jason Gerlowski edited comment on SOLR-11646 at 3/6/18 11:30 PM:
-----------------------------------------------------------------
If we wanted to start giving people nudges to switch over to the v2 API, a decent way of doing so would be by making V2 the "default" tab. Was there a particular reason you chose to keep v1 as the default?
I can see arguments either way, and don't care strongly. (e.g. Maybe the V2 API's not ready to be "default" in the docs yet, or we want to avoid confusing users.) Just wondering.
was (Author: gerlowskija):
If we wanted to start giving people nudges to switch over to the v2 API, a decent way of doing so would be by making V2 the "default" tab. Was there a particular reason you chose to keep v1 as the default?
I can see arguments either way, and don't care strongly. (e.g. Maybe the V2 API's not ready to be "default" in the docs yet, or we want to avoid confusing users.) Just wanted to mention it in case you hadn't thought of it but liked the idea.
> 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
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org