[
https://issues.apache.org/jira/browse/SOLR-10842?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16191390#comment-16191390
]
Cassandra Targett commented on SOLR-10842:
------------------------------------------
bq. anyone object to the idea that I just remove the
{{solr/site/quickstart.mdtext}} entirely since it's replaced by
{{solr/solr-ref-guide/solr-tutorial.adoc}}.
That's not going to work since precommit checks that all the links on a page
like https://lucene.apache.org/solr/7_0_0/ are "valid" links, but it's rules of
"valid" are no longer true as described in LUCENE-7911. I tried to change the
reference in {{solr/site/index.xsl}} to point to where the tutorial will be in
production, but that fails the link checker since according to it, that file
doesn't exist (it's not wrong in its own context).
So, we can't have a hard-link using {{lucene.apache.org}} and we can't use a
relative link that we know works.
The only solution I know of right now is to remove
{{solr/site/quickstart.mdtext}} and remove any link to the tutorial from
{{solr/site/index.xsl}}. If anyone has a better solution, I humbly request your
assistance.
> Move quickstart.html to Ref Guide
> ---------------------------------
>
> Key: SOLR-10842
> URL: https://issues.apache.org/jira/browse/SOLR-10842
> Project: Solr
> Issue Type: Improvement
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation
> Reporter: Cassandra Targett
> Assignee: Cassandra Targett
> Priority: Minor
> Fix For: 7.0
>
> Attachments: SOLR-10842.patch
>
>
> The Solr Quick Start at https://lucene.apache.org/solr/quickstart.html has
> been problematic to keep up to date - until Ishan just updated it yesterday
> for 6.6, it said "6.2.1", so hadn't been updated for several releases.
> Now that the Ref Guide is in AsciiDoc format, we can easily use variables for
> package versions, and it could be released as part of the Ref Guide and kept
> up to date. It could also integrate links to more information on topics, and
> users would already be IN the docs, so they would not need to wonder where
> the docs are.
> There are a few places on the site that will need to be updated to point to
> the new location, but I can also put a redirect rule into .htaccess so people
> are redirected to the new location if there are other links "in the wild"
> that we cannot control. This allows it to be versioned also, if that becomes
> necessary.
> As part of this, I would like to also update the entire "Getting Started"
> section of the Ref Guide, which is effectively identical to what was in the
> first release of the Ref Guide back in 2009 for Solr 1.4 and is in serious
> need of reconsideration.
> My thought is that moving the page + redoing the Getting Started section
> would be for 7.0, but if folks are excited about this idea I could move the
> page for 6.6 and hold off redoing the larger section until 7.0.
--
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
