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

["Hoss Man (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/SOLR-11540?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Hoss Man updated SOLR-11540:
----------------------------
    Attachment: SOLR-11540.patch

Here's a patch with all the useful jekyll template changes from the older patch in the parent issue -- but w/o any of the "make shortname from title" changes (leverage the new improvements in SOLR-11540)

comparing the generated {{html-site}} output between the current output and the new output with the patch, the only (non-whitespace) changes are to the {{html-site/meta-docs}} -- which already have lots of rendering problems because the layouts aren't really designed to work with the files in that subdirectory, these changes just "fix" some of those problems (because the meta docs don't currently have the {{page-shortname}} attributes defined, but with the patch they don't need them -- they get implicitly derived from the filename)

----

I think this is good to go?

> eliminate the need for page-shortname and/or page-permalink attributes in our asciidoc source files
> ---------------------------------------------------------------------------------------------------
>
>                 Key: SOLR-11540
>                 URL: https://issues.apache.org/jira/browse/SOLR-11540
>             Project: Solr
>          Issue Type: Sub-task
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation
>            Reporter: Hoss Man
>            Assignee: Hoss Man
>         Attachments: SOLR-11540.patch
>
>
> From parent issue...
> bq. 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)



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org