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

Reply via email to