You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Hoss Man (JIRA)" <ji...@apache.org> on 2017/11/03 16:39:00 UTC

[jira] [Assigned] (SOLR-10934) create a link+anchor checker for the ref-guide that only depends on ivy resources

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

Hoss Man reassigned SOLR-10934:
-------------------------------

       Assignee: Hoss Man
    Description: 
We currently have CheckLinksAndAnchors.java which is automatically run against the ref-guide HTML as part of the build to use JSoup to find bad links/anchors that asciidoctor doesn't complain about -- but not everyone does/can build the HTML version of the ref-guide sincif we can e it requires manually installing jekyll.

This issue initially focused on trying to use PDFBox to do link+anchor checking directly against the "final" PDF, but by that point a lot of information that indicates problems (dup anchors, links pointing to the wrong place in the document, etc...) is already lost.

The current focus is on a way to catch all of the same types of problems we can currently catch today, in a way that anyone can run purely from ant -- w/o any manually instaled tools like jekyll.


  was:
We currently have CheckLinksAndAnchors.java which is automatically run against the ref-guide HTML as part of the build to use JSoup to find bad links/anchors that asciidoctor doesn't complain about -- but not everyone does/can build the HTML version of the ref-guide sincif we can e it requires manually installing jekyll.

The PDF build only requires things installed by ivy (via JRuby) and we already have some PDFBox based code in ReducePDFSize.java that operates on this PDF every time it's run -- so if we can find a way to do similar checks using the PDFBox API we could catch these broken links faster.

        Summary: create a link+anchor checker for the ref-guide that only depends on ivy resources  (was: create a link+anchor checker for the ref-guide PDF using PDFBox)

> create a link+anchor checker for the ref-guide that only depends on ivy resources
> ---------------------------------------------------------------------------------
>
>                 Key: SOLR-10934
>                 URL: https://issues.apache.org/jira/browse/SOLR-10934
>             Project: Solr
>          Issue Type: Sub-task
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation
>            Reporter: Hoss Man
>            Assignee: Hoss Man
>            Priority: Major
>         Attachments: SOLR-10934.patch, SOLR-10934.patch
>
>
> We currently have CheckLinksAndAnchors.java which is automatically run against the ref-guide HTML as part of the build to use JSoup to find bad links/anchors that asciidoctor doesn't complain about -- but not everyone does/can build the HTML version of the ref-guide sincif we can e it requires manually installing jekyll.
> This issue initially focused on trying to use PDFBox to do link+anchor checking directly against the "final" PDF, but by that point a lot of information that indicates problems (dup anchors, links pointing to the wrong place in the document, etc...) is already lost.
> The current focus is on a way to catch all of the same types of problems we can currently catch today, in a way that anyone can run purely from ant -- w/o any manually instaled tools like jekyll.



--
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