Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-30 Thread Roc Marshal
Hi, David. I am sorry for late reply. I will check pages which were translated by me according to your reply. Thank you so much. Best, Roc. | | Roc Marshal | | 邮箱:flin...@126.com | 签名由 网易邮箱大师 定制 On 06/30/2020 15:20, David Anderson wrote: Yes, it makes sense to rewrite img tags and

Re: Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-30 Thread David Anderson
Yes, it makes sense to rewrite img tags and other resources using {% link ... %}, but, for example, wrote: > Yes, I think this rule also applies to resources, e.g. "{% link > fig/stream_barriers.svg %}". Because it will help us to prevent dead links. > Please correct me if I'm wrong @Seth. > >

Re: Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-27 Thread Jark Wu
Yes, I think this rule also applies to resources, e.g. "{% link fig/stream_barriers.svg %}". Because it will help us to prevent dead links. Please correct me if I'm wrong @Seth. Best, Jark On Fri, 26 Jun 2020 at 22:30, Roc Marshal wrote: > Hi everyone, > > > There is a question about

Re:Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-26 Thread Roc Marshal
Hi everyone, There is a question about optimizing and translating documents. If the link target is an internal image, does the link method need to be set as the same way that link target is other pages. Such as : Should """ src="{{ site.baseurl }}/fig/stream_barriers.svg" """ be

Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-16 Thread Yangze Guo
I second Jark's comment. We need a CI mechanism to ensure this. Best, Yangze Guo On Wed, Jun 17, 2020 at 11:45 AM Jark Wu wrote: > > Hi everyone, > > Before going to use {% link %} and adding a CI to force using link tag, I > suggest adding a CI profile to check broken links first. > > The

Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-16 Thread Jark Wu
Hi everyone, Before going to use {% link %} and adding a CI to force using link tag, I suggest adding a CI profile to check broken links first. The background is that, recently, I noticed that many contributors are beginning to use link tags, but forget to link ".zh.md" instead of ".md" in

Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-14 Thread Congxian Qiu
+1 to use {% link %} tag and add a check during CI. for Chinese doc, will suggest the Chinese translate contributor use the {% link %} tag when reviewing the translate pr. Best, Congxian Jark Wu 于2020年6月10日周三 上午10:48写道: > +1 to use {% link %} tag and add check in CI. > > Tips: if want to

Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-09 Thread Jark Wu
+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 wrote: > Thanks for that reminder, Seth! > > +1 to add a check during CI if possible. > > Best, > Yangze Guo

Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-09 Thread Yangze Guo
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 wrote: > > Thanks for the heads up Seth! > > Kostas > > On Tue, Jun 9, 2020 at 7:27 PM Seth Wiesman wrote: > > > > The tag is new to Jekyll 4.0 which we

Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-09 Thread Kostas Kloudas
Thanks for the heads up Seth! Kostas On Tue, Jun 9, 2020 at 7:27 PM Seth Wiesman 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

Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-09 Thread Seth Wiesman
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

Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-09 Thread Robert Metzger
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 wrote: > Whoops,

Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-09 Thread Seth Wiesman
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 wrote: > Thank you for noticing that, the guide is out of date. I will fix that > immediately! > > On Tue, Jun 9, 2020 at

Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-09 Thread Seth Wiesman
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 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 ( >

Re: [Reminder] Prefer {% link %} tag in documentation

2020-06-09 Thread Dawid Wysakowicz
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

[Reminder] Prefer {% link %} tag in documentation

2020-06-09 Thread Seth Wiesman
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