camel-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <>
Subject [jira] [Commented] (CAMEL-12246) New AsciiDoc documentation has many broken links
Date Fri, 09 Feb 2018 12:57:01 GMT


ASF GitHub Bot commented on CAMEL-12246:

GitHub user fbolton opened a pull request:

    CAMEL-12246 Fix broken links

    @davsclaus and @oscerd, here are the changes to the AsciiDoc linking that we discussed.
Here's a summary of what was done:
    * Resolve the duplicate IDs (can't do any harm, and is actually required for our downstream
    * Take into account the -eip suffix, which might reduce the number of unresolved links.
    * All resolvable links to be transformed to AsciiDoc cross-reference format, as follows:
    link:LINKNAME.html[Text of Link]  =>  <<LINKNAME, Text of Link>>
      Where, in some cases, `LINKNAME` might be augmented by a `-component`, `-dataformat`,
`-language`, or `-eip` suffix.
    * Identify the broken EIP links and leave them alone. These will continue to show up as
broken links, but we can easily fix them later.
    * All other unresolved links will be removed. Probably do this by replacing:
    link:LINKNAME.html[Text of Link]   =>  Text of Link

You can merge this pull request into a Git repository by running:

    $ git pull fix-broken-links

Alternatively you can review and apply these changes as the patch at:

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #2215
commit 9641a6edb74138dc8313deba80a0a46d4236a6e4
Author: Fintan Bolton <fbolton@...>
Date:   2018-02-08T17:13:29Z

    CAMEL-12246 Fixed a duplicate ID in the AsciiDoc source

commit b61b7a18999594a32c67061eb41c3d6762db756a
Author: Fintan Bolton <fbolton@...>
Date:   2018-02-09T10:56:09Z

    CAMEL-12246 Replaced file links with AsciiDoc internal cross references

commit 5b6d0a8fcb2c36216d812d8c0bac77262f9fe743
Author: Fintan Bolton <fbolton@...>
Date:   2018-02-09T12:18:06Z

    CAMEL-12246 Replaced file links that were split over two lines (manually)

commit 8b850266f845e42901005cee568c68f73ed58661
Author: Fintan Bolton <fbolton@...>
Date:   2018-02-09T12:38:18Z

    CAMEL-12246 Replaced bad links with plain text, except for the files in camel-core/src/main/docs/eips/,
which will be fixed later


> New AsciiDoc documentation has many broken links
> ------------------------------------------------
>                 Key: CAMEL-12246
>                 URL:
>             Project: Camel
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 2.21.0
>            Reporter: Fintan Bolton
>            Priority: Major
>             Fix For: 2.21.0
> There are a fair number of broken links in the new AsciiDoc documentation (in the main
Camel repo). In other words, links like {{link:LINKNAME.html[Link Text]}} ought to have a
matching target ID, {{[[LINKNAME]]}}, in the AsciiDoc source. But I found 245 LINKNAMEs in
links that have no corresponding target ID defined.

This message was sent by Atlassian JIRA

View raw message