You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by "David Eric Pugh (Jira)" <ji...@apache.org> on 2021/02/18 18:00:00 UTC
[jira] [Commented] (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=17286639#comment-17286639 ]
David Eric Pugh commented on SOLR-11646:
----------------------------------------
[~ctargett]is there a pattern you like for formatting URLS in the docs? I see both use of backticks, and then using underscores to make a parameter value in italics, so {{name=_name}}_, but also some where we just wrap it in the {{source,bash}} formatter, and have a name like {{name=myName}}.
I am poking at adding the v2 apis to the collections-management.adoc file. SO much work.
> 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
>
> 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: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org