+1 to use {% link %} tag and add check in CI.
Tips: if want to link a Chinese page, should write: [CLI]({% link ops/
cli.zh.md %})
Best,
Jark
On Wed, 10 Jun 2020 at 10:30, Yangze Guo <karma...@gmail.com> wrote:
> Thanks for that reminder, Seth!
>
> +1 to add a check during CI if possible.
>
> Best,
> Yangze Guo
>
> On Wed, Jun 10, 2020 at 3:04 AM Kostas Kloudas <kklou...@gmail.com> wrote:
> >
> > Thanks for the heads up Seth!
> >
> > Kostas
> >
> > On Tue, Jun 9, 2020 at 7:27 PM Seth Wiesman <sjwies...@gmail.com> wrote:
> > >
> > > The tag is new to Jekyll 4.0 which we only recently updated to.
> > >
> > > There are a lot of existing tags that would need to be updated first :)
> > > I opened a ticket to track that work and then yes that would make
> sense.
> > >
> > > Seth
> > >
> > > [1] https://issues.apache.org/jira/browse/FLINK-18193
> > >
> > > On Tue, Jun 9, 2020 at 12:05 PM Robert Metzger <rmetz...@apache.org>
> wrote:
> > >
> > > > Thanks for the reminder. I was also not aware of this tag!
> > > >
> > > > How about enforcing the use of this tag through CI?
> > > > We could for example grep through the added lines of all changes in
> docs/
> > > > and fail the build if we see the wrong pattern.
> > > >
> > > >
> > > > On Tue, Jun 9, 2020 at 4:37 PM Seth Wiesman <sjwies...@gmail.com>
> wrote:
> > > >
> > > > > Whoops, responded from the wrong email :)
> > > > >
> > > > > Thank you for noticing that, the guide is out of date. I will fix
> that
> > > > > immediately!
> > > > >
> > > > > On Tue, Jun 9, 2020 at 9:36 AM Seth Wiesman <s...@ververica.com>
> wrote:
> > > > >
> > > > > > Thank you for noticing that, the guide is out of date. I will
> fix that
> > > > > > immediately!
> > > > > >
> > > > > > On Tue, Jun 9, 2020 at 9:34 AM Dawid Wysakowicz <
> > > > dwysakow...@apache.org>
> > > > > > wrote:
> > > > > >
> > > > > >> 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
> > > > > >>
> > > > > >>
> > > > > >
> > > > > > --
> > > > > >
> > > > > > Seth Wiesman | Solutions Architect
> > > > > >
> > > > > > +1 314 387 1463
> > > > > >
> > > > > > <https://www.ververica.com/>
> > > > > >
> > > > > > Follow us @VervericaData
> > > > > >
> > > > > > --
> > > > > >
> > > > > > Join Flink Forward <https://flink-forward.org/> - The Apache
> Flink
> > > > > > Conference
> > > > > >
> > > > > > Stream Processing | Event Driven | Real Time
> > > > > >
> > > > >
> > > >
>
