[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=16446261#comment-16446261 ] Cassandra Targett commented on SOLR-11646: -- I've done another round of adding v2 examples: || Page || Old API endpoint || |blob-store-api.adoc | /.system/blob |config-api.adoc | //config | |configuring-solrconfig-xml.adoc | /admin/collections | |configsets-api.adoc | /admin/configs | |implicit-requesthandlers.adoc | //config | Along the way, I made some extensive changes to a few of these pages as I noticed problems with them that needed to be fixed. The pages for configsets got updated with a bit more information about what configsets are; the config-api.adoc got better descriptions for the commands & better examples in a couple of cases; the list of implicit handlers got re-organized and pulled out of the table that looked really bad in the PDF. Remaining pages to be done: || Page || Old API endpoint || |collections-api.adoc | /admin/collections | |coreadmin-api.adoc | /admin/cores | |enabling-ssl.adoc | /admin/collections | |making-and-restoring-backups.adoc | /admin/cores | |other-parsers.adoc | //update | |request-parameters-api.adoc | //config | |rule-based-authorization-plugin.adoc | /admin/authorization | |rule-based-authorization-plugin.adoc | /admin/collections | |schema-api.adoc | //schema | |schemaless-mode.adoc | //config | |schemaless-mode.adoc | //schema | |schemaless-mode.adoc | //update | |solr-tutorial.adoc | //config | |solr-tutorial.adoc | //schema | |solr-tutorial.adoc | /admin/collections | |solrcloud-autoscaling-api.adoc | /autoscaling/* | |solrcloud-autoscaling-auto-add-replicas.adoc | /admin/collections | |solrcloud-autoscaling-fault-tolerance.adoc | /autoscaling/* | |solrcloud-autoscaling-overview.adoc | /admin/collections | |solrcloud-autoscaling-overview.adoc | /autoscaling/* | |updating-parts-of-documents.adoc | //update | |uploading-data-with-index-handlers.adoc | //update | I kept the order as "v1" then "v2" for now, only to be consistent about it while I continue to consider either putting v2 first or making the 2nd tab the default (which would require some more extensive changes to the code that's converting the asciidoc to html) is a better option. > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[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=16446252#comment-16446252 ] ASF subversion and git services commented on SOLR-11646: Commit 5915e61e42aa0311b8b574949fed8a2ec566a502 in lucene-solr's branch refs/heads/branch_7x from [~ctargett] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=5915e61 ] SOLR-11646: more v2 examples; redesign Implicit Handler page to add v2 api paths where they exist > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[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=16446251#comment-16446251 ] ASF subversion and git services commented on SOLR-11646: Commit df57afce9be949aef65330b2fe4243667c13d4c3 in lucene-solr's branch refs/heads/branch_7x from [~ctargett] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=df57afc ] SOLR-11646: Add v2 APIs for Config API; change "ConfigSet" to "configset" in docs & specs to match community spelling > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[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=16446250#comment-16446250 ] ASF subversion and git services commented on SOLR-11646: Commit b99e07c7531f1fe61e9d33dfa17b33600f12a00c in lucene-solr's branch refs/heads/master from [~ctargett] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=b99e07c ] SOLR-11646: more v2 examples; redesign Implicit Handler page to add v2 api paths where they exist > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[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=16446249#comment-16446249 ] ASF subversion and git services commented on SOLR-11646: Commit d08e62d59878147b8447698e87374dfbfeb597c1 in lucene-solr's branch refs/heads/master from [~ctargett] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=d08e62d ] SOLR-11646: Add v2 APIs for Config API; change "ConfigSet" to "configset" in docs & specs to match community spelling > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[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=16444160#comment-16444160 ] ASF subversion and git services commented on SOLR-11646: Commit 0c542c44d9ec6204bec912a6ab138a0cfb5533d0 in lucene-solr's branch refs/heads/branch_7x from [~ctargett] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=0c542c4 ] SOLR-11646: change tab-pane padding to align better under tabs > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[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=16444157#comment-16444157 ] ASF subversion and git services commented on SOLR-11646: Commit aab2c770c6f934745b23f14649ce476d582f7afb in lucene-solr's branch refs/heads/master from [~ctargett] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=aab2c77 ] SOLR-11646: change tab-pane padding to align better under tabs > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[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=16389730#comment-16389730 ] 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 (v7.6.3#76005) - To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[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=16388693#comment-16388693 ] Jason Gerlowski commented on SOLR-11646: 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[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=16381055#comment-16381055 ] ASF subversion and git services commented on SOLR-11646: Commit 1ab2f5adbac08b27b7aff484075fb4733277d4a2 in lucene-solr's branch refs/heads/branch_7x from [~ctargett] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=1ab2f5a ] Ref Guide: fix line height changed in SOLR-11646 which inadvertently vertically stretched the left-hand nav; adds a new CSS rule for tabbed sections on a page with the larger line height and changes back left-hand nav line height > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[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=16381052#comment-16381052 ] ASF subversion and git services commented on SOLR-11646: Commit 57cfdb1a48a836569c09930b65b6159652c74107 in lucene-solr's branch refs/heads/master from [~ctargett] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=57cfdb1 ] Ref Guide: fix line height changed in SOLR-11646 which inadvertently vertically stretched the left-hand nav; adds a new CSS rule for tabbed sections on a page with the larger line height and changes back left-hand nav line height > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[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=16275075#comment-16275075
]
Cassandra Targett commented on SOLR-11646:
--
The commits in earlier comments adds V2 API examples to a chunk of pages,
specifically:
|| Page || Old API endpoint ||
|adding-custom-plugins-in-solrcloud-mode.adoc | //config |
|basic-authentication-plugin.adoc | /admin/authentication |
|blob-store-api.adoc | /admin/collections |
|config-sets.adoc | /admin/cores |
|content-streams.adoc | //config |
|getting-started-with-solrcloud.adoc | //config |
|major-changes-in-solr-7.adoc | //config |
|realtime-get.adoc | //get or //get |
|requestdispatcher-in-solrconfig.adoc | //config |
|running-solr-on-hdfs.adoc | /admin/collections |
|transforming-and-indexing-custom-json.adoc | //config |
The model for these is to use the tab layout approach we added in SOLR-11584.
In the HTML pages, these will appear as tabs for users to click on to select
the example; in the PDF these will appear sequentially with the same labels
that appear in the HTML as the tab labels. A good example of how this
looks/works is this page:
https://builds.apache.org/view/L/view/Lucene/job/Solr-reference-guide-master/javadoc/transforming-and-indexing-custom-json.html
In addition to the above list, I made a few other changes to other pages,
notably {{about-this-guide.adoc}}, to which I added a section to describe what
"V1" and "V2" mean, with a link to further context for the V2 approach. Other
changes were mostly typos I noticed as I went along.
Steve Rowe pointed out to me privately that calling the "old" way of doing API
calls "V1" is really a misnomer, but when I started it I couldn't figure out
what to call them that was accurate and would be meaningful to people, so in
that context it might be the best we can do. He also thought it may be
confusing to call the "new" way "V2" since the path to the new endpoints
doesn't include "v2", but again, that's what we call it so it's the most apt
name I've come up with so far. If someone has a compelling suggestion for an
alternative I could pretty easily fix the labels so this doesn't have to be set
in stone yet.
I discovered a few pages on my original list that don't really need to updated:
|| Page || Old API endpoint || Notes ||
|configuring-logging.adoc | /admin/info/* | Doesn't accept POST requests to
modify |
|filter-descriptions.adoc | //schema | POST 'schema/analysis'
endpoint not supported in v2 |
|managed-resources.adoc | //schema | POST 'schema/analysis'
endpoint not supported in v2 |
|collections-core-admin.adoc | /admin/collections | False positive example |
|learning-to-rank.adoc | //schema | Doesn't support v2 yet |
I probably (quite likely) will not have time to finish the rest of the pages
before 7.2 Guide needs to be published, but it wasn't ever my intention to do
them all at once anyway (I said it would be a series of commits). I left myself
all the hardest ones yet to do. The remaining list of pages to review/update:
|| Page || Old API endpoint ||
|blob-store-api.adoc | /.system/blob
|collections-api.adoc | /admin/collections |
|config-api.adoc | //config |
|configsets-api.adoc | /admin/configs |
|configuring-solrconfig-xml.adoc | /admin/collections |
|coreadmin-api.adoc | /admin/cores |
|enabling-ssl.adoc | /admin/collections |
|implicit-requesthandlers.adoc | //config |
|making-and-restoring-backups.adoc | /admin/cores |
|other-parsers.adoc | //update |
|request-parameters-api.adoc | //config |
|rule-based-authorization-plugin.adoc | /admin/authorization |
|rule-based-authorization-plugin.adoc | /admin/collections |
|schema-api.adoc | //schema |
|schemaless-mode.adoc | //config |
|schemaless-mode.adoc | //schema |
|schemaless-mode.adoc | //update |
|solr-tutorial.adoc | //config |
|solr-tutorial.adoc | //schema |
|solr-tutorial.adoc | /admin/collections |
|solrcloud-autoscaling-api.adoc | /autoscaling/* |
|solrcloud-autoscaling-auto-add-replicas.adoc | /admin/collections |
|solrcloud-autoscaling-fault-tolerance.adoc | /autoscaling/* |
|solrcloud-autoscaling-overview.adoc | /admin/collections |
|solrcloud-autoscaling-overview.adoc | /autoscaling/* |
|updating-parts-of-documents.adoc | //update |
|uploading-data-with-index-handlers.adoc | //update |
Again, lots of duplicate pages there because I wanted to list out the endpoints
that need to be changed. I also missed something in blob-store-api.adoc that I
figured out after I'd started my commit, but I'll swing back and do another
batch when I have a stretch of time to work 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:
[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=16275052#comment-16275052 ] ASF subversion and git services commented on SOLR-11646: Commit 4fafbccdae412e73a85d1e2e63b0c40ff923a058 in lucene-solr's branch refs/heads/branch_7x from [~ctargett] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=4fafbcc ] SOLR-11646: Add v2 API examples to several pages; add context to about-this-guide.adoc; tweak CSS to make tabs more obvious > 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 > > 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 (v6.4.14#64029) - To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[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=16275050#comment-16275050 ] ASF subversion and git services commented on SOLR-11646: Commit f2dd3c5f853c36b64607a84c0f6e9572319643db in lucene-solr's branch refs/heads/master from [~ctargett] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=f2dd3c5 ] SOLR-11646: Add v2 API examples to several pages; add context to about-this-guide.adoc; tweak CSS to make tabs more obvious > 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 > > 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 (v6.4.14#64029) - To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[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=16254265#comment-16254265 ] Cassandra Targett commented on SOLR-11646: -- Caveats: * Not a perfect list - possibly/likely missing some * Not de-duplicated (but sorted at least) || Page || Old API endpoint || |adding-custom-plugins-in-solrcloud-mode.adoc | /.system/blob | |adding-custom-plugins-in-solrcloud-mode.adoc | //config | |basic-authentication-plugin.adoc | /admin/authentication | |blob-store-api.adoc | /.system/blob | |blob-store-api.adoc | /admin/collections | |collections-api.adoc | /admin/collections | |collections-core-admin.adoc | /admin/collections | |config-api.adoc | //config | |config-sets.adoc | /admin/cores | |configsets-api.adoc | /admin/configs | |configuring-logging.adoc | /admin/info/* | |configuring-solrconfig-xml.adoc | /admin/collections | |content-streams.adoc | //config | |coreadmin-api.adoc | /admin/cores | |enabling-ssl.adoc | /admin/collections | |filter-descriptions.adoc | //schema | |getting-started-with-solrcloud.adoc | //config | |implicit-requesthandlers.adoc | //config | |learning-to-rank.adoc | //schema | |major-changes-in-solr-7.adoc | //config | |making-and-restoring-backups.adoc | /admin/cores | |managed-resources.adoc | //schema | |other-parsers.adoc | //update | |realtime-get.adoc | //get or //get | |request-parameters-api.adoc | //config | |requestdispatcher-in-solrconfig.adoc | //config | |rule-based-authorization-plugin.adoc | /admin/authorization | |rule-based-authorization-plugin.adoc | /admin/collections | |running-solr-on-hdfs.adoc | /admin/collections | |schema-api.adoc | //schema | |schemaless-mode.adoc | //config | |schemaless-mode.adoc | //schema | |schemaless-mode.adoc | //update | |solr-tutorial.adoc | //config | |solr-tutorial.adoc | //schema | |solr-tutorial.adoc | /admin/collections | |solrcloud-autoscaling-api.adoc | /autoscaling/* | |solrcloud-autoscaling-auto-add-replicas.adoc | /admin/collections | |solrcloud-autoscaling-fault-tolerance.adoc | /autoscaling/* | |solrcloud-autoscaling-overview.adoc | /admin/collections | |solrcloud-autoscaling-overview.adoc | /autoscaling/* | |transforming-and-indexing-custom-json.adoc | //config | |updating-parts-of-documents.adoc | //update | |uploading-data-with-index-handlers.adoc | //update | > 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 > > 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 (v6.4.14#64029) - To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
