[
https://issues.apache.org/jira/browse/FLINK-20298?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17238669#comment-17238669
]
Dawid Wysakowicz edited comment on FLINK-20298 at 11/25/20, 10:46 AM:
----------------------------------------------------------------------
A heads up.
There is a question if we want to remove the site.baseurl entirely we must
figure out something for linking to javadocs. Internally [~alpinegizmo]
suggested:
{quote}We already have a site.javadocs_baseurl (that points to the same place
as site.baseurl) that can be used for Javadoc links. Or we could implement our
own \{% javadocs_link ... %} plugin, similar to the gh_link plugin that we
already have. With some effort we could get rid of site.baseurl, if we deem it
worth the effort.
{quote}
was (Author: dawidwys):
A heads up.
There is a question if we want to remove the site.baseurl entirely we must
figure out something for linking to javadocs. Internally [~alpinegizmo]
suggested:
{quote}We already have a site.javadocs_baseurl (that points to the same place
as site.baseurl) that can be used for Javadoc links. Or we could implement our
own {% javadocs_link ... %} plugin, similar to the gh_link plugin that we
already have. With some effort we could get rid of site.baseurl, if we deem it
worth the effort.
{quote}
> Replace usage of {{site.baseurl}} in flink documentation
> --------------------------------------------------------
>
> Key: FLINK-20298
> URL: https://issues.apache.org/jira/browse/FLINK-20298
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
> Reporter: Dawid Wysakowicz
> Assignee: Xiao Huang
> Priority: Major
> Labels: starter
>
> We should remove all usages of \{{site.baseurl}} from our documentation. It
> is encourages to use \{% link ... %} instead. Having the old version still in
> the docs we risk introducing more of the discouraged version, as people not
> too familiar with jekyll might simply copy over from other places.
> Moreover we should update our documentation guide where the section that
> explains image linking uses the discouraged version.
> Ideally we should remove the \{{site.baseurl}} so any usage of it will fail
> the compilation.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
