[
https://issues.apache.org/jira/browse/SOLR-6871?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15423207#comment-15423207
]
Christine Poerschke commented on SOLR-6871:
-------------------------------------------
Observations/Ideas from reading through
http://lucene.apache.org/solr/quickstart.html today.
*
https://svn.apache.org/viewvc/lucene/cms/trunk/content/solr/quickstart.mdtext?revision=1705020
appears to be the source code but as mentioned above there is also in git
(older version)
https://github.com/apache/lucene-solr/blob/master/solr/site/quickstart.mdtext
of the quickstart tutorial
* We could link the "release" part of the "... you will need ... An Apache Solr
release." to the download page. ([line
13|https://svn.apache.org/viewvc/lucene/cms/trunk/content/solr/quickstart.mdtext?revision=1705020&view=markup#l13])
* The "Query tab" link appears to be broken. ([line
106|https://svn.apache.org/viewvc/lucene/cms/trunk/content/solr/quickstart.mdtext?revision=1705020&view=markup#l106])
* The "Transforming and Indexing Custom JSON data" link appears to be broken.
([line
192|https://svn.apache.org/viewvc/lucene/cms/trunk/content/solr/quickstart.mdtext?revision=1705020&view=markup#l192])
* 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. ([line
169|https://svn.apache.org/viewvc/lucene/cms/trunk/content/solr/quickstart.mdtext?revision=1705020&view=markup#l169])
* The "Indexing CSV" heading could link into the reference guide also. ([line
194|https://svn.apache.org/viewvc/lucene/cms/trunk/content/solr/quickstart.mdtext?revision=1705020&view=markup#l194])
> 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: [email protected]
For additional commands, e-mail: [email protected]
