> #2 (write script to shorten redundant page names in anchor names) is > especially needed.
There may be a plan to auto redirect Confluence links to the new guide, see https://issues.apache.org/jira/browse/SOLR-10595 <https://issues.apache.org/jira/browse/SOLR-10595> and if someone clicks a link with an anchor, the redirect will not manage to scroll to correct sub heading if we change every single anchor. But the redirect will get to the correct page, which is probably good enough. I haven’t thought through the redirect/alias part very much yet. The idea would be that you could add an alias with a commit to the guide itself, not introducing any .htaccess, servlets or other things. If we used Javascript for the redirect, then perhaps we could have a format such as http://solr.guide/s.html#schema and have the JS parse the string after # and change .location ? Idea #4: Provide an icon next to every header, that will generate a version-independent link, i.e. a link without “/6_6“ in it. The way the site is setup now, omitting the version in the URL will redirect to that page in the current version of the guide (htaccess?) This is useful for links that describe concepts, but is of course prone to page renames in the future, unless we enforce a polify that a page rename shall leave the old page.html in place with a redirect? -- Jan Høydahl, search solution architect Cominvent AS - www.cominvent.com > 10. jul. 2017 kl. 05.59 skrev David Smiley <[email protected]>: > > 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] > <mailto:[email protected]>> wrote: > Hi, > > I started to replace old wiki.apache.org/solr <http://wiki.apache.org/solr> > and cwiki.apache.org/solr <http://cwiki.apache.org/solr> links to point to > relevant > sections in the new online Reference Guide lucene.apache.org/solr/guide/ > <http://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 > <http://wiki.apache.org/solr/SchemaXml#Similarity> > Cwiki: > > https://cwiki.apache.org/confluence/display/solr/Other+Schema+Elements#OtherSchemaElements-Similarity > > <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 > > <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/ > <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/ > <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/s/schema.html> ==> > http://solr.guide/6_6/documents-fields-and-schema-design.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 <http://www.cominvent.com/> > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [email protected] > <mailto:[email protected]> > For additional commands, e-mail: [email protected] > <mailto:[email protected]> > > -- > Lucene/Solr Search Committer, Consultant, Developer, Author, Speaker > LinkedIn: http://linkedin.com/in/davidwsmiley > <http://linkedin.com/in/davidwsmiley> | Book: > http://www.solrenterprisesearchserver.com > <http://www.solrenterprisesearchserver.com/>
