flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Enrique Bautista Barahona (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-2300) Links on FAQ page not rendered correctly
Date Wed, 15 Jul 2015 19:04:04 GMT

    [ https://issues.apache.org/jira/browse/FLINK-2300?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14628555#comment-14628555
] 

Enrique Bautista Barahona commented on FLINK-2300:
--------------------------------------------------

[~mxm], I've thought about this and maybe it doesn't make much sense to update the links.

The plugin let us hide the base url but, after all:
- there aren't that much links of that type, and they aren't that much different from a regular
link
- you have to write the rest of the path to the file or folder, which can and usually will
be quite long and messy (e.g. {{flink-java/src/main/java/org/apache/flink/api/java/ExecutionEnvironment.java#L831}}).
- there are a lot of other explicit markdown links to the GitHub Apache repo, the Stratosphere
repo, the issue tracker, mailing lists, etc.; some of them with hardcoded urls, some of them
reading constants from the config file.

I think it would be simpler to just not use the plugin at all (remove it, even) and instead
write regular markdown links. If you still want to abstract or reuse the urls, it may be better
to just use the config file. But for the sake of consistency, maybe it should be done with
every link, and I'm not sure it's worth it.

> Links on FAQ page not rendered correctly
> ----------------------------------------
>
>                 Key: FLINK-2300
>                 URL: https://issues.apache.org/jira/browse/FLINK-2300
>             Project: Flink
>          Issue Type: Bug
>          Components: Project Website
>            Reporter: Robert Metzger
>            Assignee: Maximilian Michels
>            Priority: Minor
>              Labels: starter
>         Attachments: fix_github_plugin.patch
>
>
> On the Flink website, the links using the "github" plugin are broken.
> For example
> {code}
> {% github README.md master "build instructions" %}
> {code}
> renders to
> {code}
> https://github.com/apache/flink/tree/master/README.md
> {code}
> See:
> http://flink.apache.org/faq.html#my-job-fails-early-with-a-javaioeofexception-what-could-be-the-cause
> I was not able to resolve the issue by using {{<a>}} tags or markdown links.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message