[jira] [Updated] (SOLR-6871) Need a process for updating & maintaining the new quickstart tutorial (and any other tutorials added to the website)
[ https://issues.apache.org/jira/browse/SOLR-6871?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Steve Rowe updated SOLR-6871: - Fix Version/s: (was: 5.0) > Need a process for updating & maintaining the new quickstart tutorial (and > any other tutorials added to the website) > > > Key: SOLR-6871 > URL: https://issues.apache.org/jira/browse/SOLR-6871 > Project: Solr > Issue Type: Task >Reporter: Hoss Man >Assignee: Steve Rowe >Priority: Minor > Attachments: SOLR-6871.patch > > > Prior to SOLR-6058 the /solr/tutorial.html link on the website contained only > a simple landing page that then linked people to the "versioned" tutorial for > the most recent release -- or more specificly: the most recent release*s* > (plural) when we were releasing off of multiple branches (ie: links to both > the 4.0.0 tutorial, as well as the 3.6.3 tutorial when 4.0 came out) > The old tutorial content lived along side the solr code, and was > automatically branched, tagged & released along with Solr. When committing > any changes to Solr code (or post.jar code, or the sample data, or the sample > configs, etc..) you could also commit changes to the tutorial at th same time > and be confident that it was clear what version of solr that tutorial went > along with. > As part of SOLR-6058, it seems that there was a concensus to move to a > keeping "tutorial" content on the website, where it can be integrated > directly in with other site content/navigation, and use the same look and > feel. > I have no objection to this in principle -- but as a result of this choice, > there are outstanding issues regarding how devs should go about maintaining > this doc as changes are made to solr & the solr examples used in the tutorial. > We need a clear process for where/how to edit the tutorial(s) as new versions > of solr come out and cahnges are made that mandate corisponding hanges to the > tutorial. this process _should_ also account for things like having multiple > versions of the tutorial live at one time (ie: at some point in the future, > we'll certainly need to host the "5.13" tutorial if that's the current > "stable" release, but we'll also want to host the tutorial for "6.0-BETA" so > that people can try it out) -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Updated] (SOLR-6871) Need a process for updating & maintaining the new quickstart tutorial (and any other tutorials added to the website)
[ https://issues.apache.org/jira/browse/SOLR-6871?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Steve Rowe updated SOLR-6871: - Attachment: SOLR-6871.patch Patch updating the quickstart tutorial to 6.2.0 - the patch mentions but doesn't include a few screen capture images I modified to bring them up-to-date. I addressed all [~cpoerschke]'s suggestions above, except for: bq. The "Indexing JSON" heading could become "Indexing Solr JSON" and its paragraph link into the Solr JSON reference guide section as is done for Solr XML. -- I added a link to the ref guide section, but I left the heading as "Indexing JSON", since both and custom and Solr JSON are described there. I addressed the per-field search borkedness mentioned in SOLR-9526 by simply upcasing the search term {{name:foundation}} to {{name:Foundation}} - this works because strings fields can be successfully queried with exact full field values. I decided to leave in per-field querying, and not mention any caveats, since I figure SOLR-9526 will change the situation shortly. I didn't find any other problems. Finally, the patch also includes a new target {{generate-website-quickstart}} in {{solr/build.xml}} that makes few minor modifications to {{quickstart.mdtext}} (see comments in the build file for details) and puts the result at {{solr/build/website/quickstart.mdtext}}. This is a low-impact mechanism to allow the content to be shared between the bundled docs and the website. If there are no objections I'll commit in a day or so, and put the modified version of the quickstart tutorial up on the website. > Need a process for updating & maintaining the new quickstart tutorial (and > any other tutorials added to the website) > > > Key: SOLR-6871 > URL: https://issues.apache.org/jira/browse/SOLR-6871 > Project: Solr > Issue Type: Task >Reporter: Hoss Man >Priority: Minor > Fix For: 5.0 > > Attachments: SOLR-6871.patch > > > Prior to SOLR-6058 the /solr/tutorial.html link on the website contained only > a simple landing page that then linked people to the "versioned" tutorial for > the most recent release -- or more specificly: the most recent release*s* > (plural) when we were releasing off of multiple branches (ie: links to both > the 4.0.0 tutorial, as well as the 3.6.3 tutorial when 4.0 came out) > The old tutorial content lived along side the solr code, and was > automatically branched, tagged & released along with Solr. When committing > any changes to Solr code (or post.jar code, or the sample data, or the sample > configs, etc..) you could also commit changes to the tutorial at th same time > and be confident that it was clear what version of solr that tutorial went > along with. > As part of SOLR-6058, it seems that there was a concensus to move to a > keeping "tutorial" content on the website, where it can be integrated > directly in with other site content/navigation, and use the same look and > feel. > I have no objection to this in principle -- but as a result of this choice, > there are outstanding issues regarding how devs should go about maintaining > this doc as changes are made to solr & the solr examples used in the tutorial. > We need a clear process for where/how to edit the tutorial(s) as new versions > of solr come out and cahnges are made that mandate corisponding hanges to the > tutorial. this process _should_ also account for things like having multiple > versions of the tutorial live at one time (ie: at some point in the future, > we'll certainly need to host the "5.13" tutorial if that's the current > "stable" release, but we'll also want to host the tutorial for "6.0-BETA" so > that people can try it out) -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Updated] (SOLR-6871) Need a process for updating & maintaining the new quickstart tutorial (and any other tutorials added to the website)
[ https://issues.apache.org/jira/browse/SOLR-6871?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Adrien Grand updated SOLR-6871: --- Priority: Minor (was: Blocker) > Need a process for updating & maintaining the new quickstart tutorial (and > any other tutorials added to the website) > > > Key: SOLR-6871 > URL: https://issues.apache.org/jira/browse/SOLR-6871 > Project: Solr > Issue Type: Task >Reporter: Hoss Man >Priority: Minor > Fix For: 5.0 > > > Prior to SOLR-6058 the /solr/tutorial.html link on the website contained only > a simple landing page that then linked people to the "versioned" tutorial for > the most recent release -- or more specificly: the most recent release*s* > (plural) when we were releasing off of multiple branches (ie: links to both > the 4.0.0 tutorial, as well as the 3.6.3 tutorial when 4.0 came out) > The old tutorial content lived along side the solr code, and was > automatically branched, tagged & released along with Solr. When committing > any changes to Solr code (or post.jar code, or the sample data, or the sample > configs, etc..) you could also commit changes to the tutorial at th same time > and be confident that it was clear what version of solr that tutorial went > along with. > As part of SOLR-6058, it seems that there was a concensus to move to a > keeping "tutorial" content on the website, where it can be integrated > directly in with other site content/navigation, and use the same look and > feel. > I have no objection to this in principle -- but as a result of this choice, > there are outstanding issues regarding how devs should go about maintaining > this doc as changes are made to solr & the solr examples used in the tutorial. > We need a clear process for where/how to edit the tutorial(s) as new versions > of solr come out and cahnges are made that mandate corisponding hanges to the > tutorial. this process _should_ also account for things like having multiple > versions of the tutorial live at one time (ie: at some point in the future, > we'll certainly need to host the "5.13" tutorial if that's the current > "stable" release, but we'll also want to host the tutorial for "6.0-BETA" so > that people can try it out) -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org