Hi Seth,

Thanks I did not know that.

I am not entirely sure, but I think our documentation guide is slightly
outdated on that manner
(https://flink.apache.org/contributing/docs-style.html) Or is there a
mistake in your example? Our guide recommends:

[CLI](|{{site.baseurl}}|{% link ops/cli.md %})

Best,

Dawid

On 09/06/2020 16:20, Seth Wiesman wrote:
> Hi Everyone!
>
> As we are seeing an influx of documentation PRs in anticipation of the 1.11
> release I would like to remind everyone to use the {% link %} tag when
> cross-linking pages[1]. This is opposed to creating a link based on
> site.baseurl.
>
> Going forward a link such as:
>
> [CLI]({% site.baseurl %}/ops/cli.html)
>
> Should be written as:
>
> [CLI]({% link ops/cli.md %})
>
> This tag will fail the build on broken links which will help us prevent
> 404s on the website.
>
> You can see a good example of the link tag in action here[2].
>
> Seth
>
> [1] https://jekyllrb.com/docs/liquid/tags/
> [2]
> https://github.com/apache/flink/blame/b6ea96251d101ca25aa6a6b92170cfa4274b4cc3/docs/index.md#L65-L67
>

Attachment: signature.asc
Description: OpenPGP digital signature

Reply via email to