[SOLR-11540] eliminate the need for page-shortname and/or page-permalink attributes in our asciidoc source files

• Type: Sub-task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 7.2, 8.0
• Component/s: documentation
• Assignee: Chris M. Hostetter
• Reporter: Chris M. Hostetter
• Created: 24/Oct/17 18:15
• Updated: 22/Dec/17 08:31
• Resolved: 25/Oct/17 17:19

Description

From parent issue...

Furthermore: the entire page-shortname and page-permalink variables in all of our *.adoc files arn't really neccessary – they are a convention I introduced early on in the process of building our the sidebar & next/pre link generation logic, but are error prone if/when people rename files.

Assuming SOLR-11539 works out, we can implicitly (in BuildNavAndPDFBody and our jekyll templates) use the basename of the file.adoc as the shortname, and use shortname + ".html" as the permalink and be done with it.

If SOLR-11539 doesn't work out, we can still generate those variables in the same way – but we also have to validate that the generated values match the title (see existing patch in parent issue)

Issue Links

• blocks: SOLR-11541 purge unneccessary page-shortname and page-permalink attributes from all source docs
• is blocked by: SOLR-11539 autogenerated pdf-main-body.adoc should use explicit anchors for each included page