Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-11531 ref-guide build tool assumptions missmatch with how "section" level anchor ids are actaully generated in PDF
  3. SOLR-11540

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

    XMLWordPrintableJSON

    Details

    • Type: Sub-task
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 7.2, 8.0
    • Component/s: documentation
    • Labels:
      None

      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)

        Attachments

        1. SOLR-11540.patch
          8 kB
          Chris M. Hostetter

          Issue Links

            Activity

              People

              • Assignee:
                hossman Chris M. Hostetter
                Reporter:
                hossman Chris M. Hostetter
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: