Your 3 proposals look excellent Jan! #2 (write script to shorten redundant page names in anchor names) is especially needed.
~ David On Sun, Jul 9, 2017 at 3:53 PM Jan Høydahl <[email protected]> wrote: > Hi, > > I started to replace old wiki.apache.org/solr and cwiki.apache.org/solr > links to point to relevant > sections in the new online Reference Guide lucene.apache.org/solr/guide/ > and discover pretty soon > that the URLs for the new guide are pretty long, e.g: > > Wiki: > http://wiki.apache.org/solr/SchemaXml#Similarity > Cwiki: > > https://cwiki.apache.org/confluence/display/solr/Other+Schema+Elements#OtherSchemaElements-Similarity > New ref-guide: > > http://lucene.apache.org/solr/guide/other-schema-elements.html#OtherSchemaElements-Similarity > > > There are several things to note here: > * Long domain and prefix: http://lucene.apache.org/solr/guide/ > * The anchor name typically repeats the page name: > other-schema-elements.html # OtherSchemaElements-Similarity > This is a legacy from how Confluence auto generated anchors > > Since ref-guide is the main goto-docs for Solr I’d like the URLs to be as > short as possible, preferable > so that you can remember the most prominent pages and type them by hand, > and that they can easily be pasted > into a flowing text without always breaking to the next line because they > are too long. > > Proposals: > 1. Register a domain for the guide, e.g. http://solr.guide/ — 12 chars > instead of 30 ($35/yr) > 2. Write a script that removes the duplicate names in anchors, and run a > one-time conversion > e.g. converts #OtherSchemaElements-Similarity to #Similarity > 3. Introduce a shortcut page for the refGuide, to create shortcuts for the > most frequently used > guide locations, e.g. create a page s.adoc that contains a long list of > short-links and a Javascript > that performs a redirect. Example: > http://solr.guide/s/schema.html ==> > http://solr.guide/6_6/documents-fields-and-schema-design.html > > Just throwing this out here before creating JIRAs. What do you think? > > -- > Jan Høydahl, search solution architect > Cominvent AS - www.cominvent.com > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [email protected] > For additional commands, e-mail: [email protected] > > -- Lucene/Solr Search Committer, Consultant, Developer, Author, Speaker LinkedIn: http://linkedin.com/in/davidwsmiley | Book: http://www.solrenterprisesearchserver.com
