Hi All,
I would like to start a discussion for FLIP-157: Migrating the Flink docs from Jekyll to Hugo. This will allow us: - Proper internationalization - Working Search - Sub-second build time ;) Please take a look and let me know what you think. Seth https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo |
+1 to do this. I really like what you have build and the advantages to Jekyll seem overwhelming to me. Hugo is very flexible and I've seen a few other projects use it successfully for docs.
On Wed, Jan 13, 2021, at 5:14 PM, Seth Wiesman wrote: > Hi All, > > I would like to start a discussion for FLIP-157: Migrating the Flink docs > from Jekyll to Hugo. > > This will allow us: > > - Proper internationalization > - Working Search > - Sub-second build time ;) > > Please take a look and let me know what you think. > > Seth > > https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo > |
The build time sounds impressive.
Could you explain more what strong internationalization features it provides? Best, Jark On Thu, 14 Jan 2021 at 01:01, Ufuk Celebi <[hidden email]> wrote: > +1 to do this. I really like what you have build and the advantages to > Jekyll seem overwhelming to me. Hugo is very flexible and I've seen a few > other projects use it successfully for docs. > > On Wed, Jan 13, 2021, at 5:14 PM, Seth Wiesman wrote: > > Hi All, > > > > I would like to start a discussion for FLIP-157: Migrating the Flink docs > > from Jekyll to Hugo. > > > > This will allow us: > > > > - Proper internationalization > > - Working Search > > - Sub-second build time ;) > > > > Please take a look and let me know what you think. > > > > Seth > > > > > https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo > > > |
+1 for this proposal.
I really like this idea for much less build time and no more docker or ruby dependencies. Developers in China often suffer with the international network connect. Best Yun Tang ________________________________ From: Jark Wu <[hidden email]> Sent: Thursday, January 14, 2021 10:49 To: dev <[hidden email]> Subject: Re: [DISCUSS] FLIP-157 Migrate Flink Documentation from Jekyll to Hugo The build time sounds impressive. Could you explain more what strong internationalization features it provides? Best, Jark On Thu, 14 Jan 2021 at 01:01, Ufuk Celebi <[hidden email]> wrote: > +1 to do this. I really like what you have build and the advantages to > Jekyll seem overwhelming to me. Hugo is very flexible and I've seen a few > other projects use it successfully for docs. > > On Wed, Jan 13, 2021, at 5:14 PM, Seth Wiesman wrote: > > Hi All, > > > > I would like to start a discussion for FLIP-157: Migrating the Flink docs > > from Jekyll to Hugo. > > > > This will allow us: > > > > - Proper internationalization > > - Working Search > > - Sub-second build time ;) > > > > Please take a look and let me know what you think. > > > > Seth > > > > > https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo > > > |
In reply to this post by Seth Wiesman-4
Great idea!
The current infrastructure is really painful with its long build times... Best, Dawid On 13/01/2021 17:14, Seth Wiesman wrote: > Hi All, > > I would like to start a discussion for FLIP-157: Migrating the Flink docs > from Jekyll to Hugo. > > This will allow us: > > - Proper internationalization > - Working Search > - Sub-second build time ;) > > Please take a look and let me know what you think. > > Seth > > https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo > signature.asc (849 bytes) Download Attachment |
The benefits of Hugo look convincing to me. Faster build times, working
search and proper internationalization are important. Hence, I am +1 for FLIP-157. Are there any downsides over using Jekyll you have discovered so far? Cheers, Till On Thu, Jan 14, 2021 at 10:18 AM Dawid Wysakowicz <[hidden email]> wrote: > Great idea! > > The current infrastructure is really painful with its long build times... > > Best, > > Dawid > > On 13/01/2021 17:14, Seth Wiesman wrote: > > Hi All, > > > > I would like to start a discussion for FLIP-157: Migrating the Flink docs > > from Jekyll to Hugo. > > > > This will allow us: > > > > - Proper internationalization > > - Working Search > > - Sub-second build time ;) > > > > Please take a look and let me know what you think. > > > > Seth > > > > > https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo > > > > |
In reply to this post by Seth Wiesman-4
Did you already try to set this up on buildbot? I assume that we'd have
to ask infra to set this up for us? On 1/13/2021 5:14 PM, Seth Wiesman wrote: > Hi All, > > I would like to start a discussion for FLIP-157: Migrating the Flink docs > from Jekyll to Hugo. > > This will allow us: > > - Proper internationalization > - Working Search > - Sub-second build time ;) > > Please take a look and let me know what you think. > > Seth > > https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo > |
In reply to this post by Seth Wiesman-4
+1
The build times on Jekyll have just become to annoying for me. I realize that that is also a function of how we structure our documentation, and especially how we construct the nav sidebar, but I think overall moving to Hugo is still a benefit. Aljoscha On 2021/01/13 10:14, Seth Wiesman wrote: >Hi All, > >I would like to start a discussion for FLIP-157: Migrating the Flink docs >from Jekyll to Hugo. > >This will allow us: > > - Proper internationalization > - Working Search > - Sub-second build time ;) > >Please take a look and let me know what you think. > >Seth > >https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo |
+1 for migrating to Hugo.
Currently we have developed many plugins based on Jekyll because the native features of Jekyll cannot meet our needs. It seems all of them can be supported via Hugo shortcodes and will become more concise. Best, Wei > 在 2021年1月14日,18:21,Aljoscha Krettek <[hidden email]> 写道: > > +1 > > The build times on Jekyll have just become to annoying for me. I realize that that is also a function of how we structure our documentation, and especially how we construct the nav sidebar, but I think overall moving to Hugo is still a benefit. > > Aljoscha > > On 2021/01/13 10:14, Seth Wiesman wrote: >> Hi All, >> >> I would like to start a discussion for FLIP-157: Migrating the Flink docs >> from Jekyll to Hugo. >> >> This will allow us: >> >> - Proper internationalization >> - Working Search >> - Sub-second build time ;) >> >> Please take a look and let me know what you think. >> >> Seth >> >> https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo |
+1 for moving to Hugo.
Cheers, Kostas On Thu, Jan 14, 2021 at 1:27 PM Wei Zhong <[hidden email]> wrote: > > +1 for migrating to Hugo. > > Currently we have developed many plugins based on Jekyll because the native features of Jekyll cannot meet our needs. It seems all of them can be supported via Hugo shortcodes and will become more concise. > > Best, > Wei > > > 在 2021年1月14日,18:21,Aljoscha Krettek <[hidden email]> 写道: > > > > +1 > > > > The build times on Jekyll have just become to annoying for me. I realize that that is also a function of how we structure our documentation, and especially how we construct the nav sidebar, but I think overall moving to Hugo is still a benefit. > > > > Aljoscha > > > > On 2021/01/13 10:14, Seth Wiesman wrote: > >> Hi All, > >> > >> I would like to start a discussion for FLIP-157: Migrating the Flink docs > >> from Jekyll to Hugo. > >> > >> This will allow us: > >> > >> - Proper internationalization > >> - Working Search > >> - Sub-second build time ;) > >> > >> Please take a look and let me know what you think. > >> > >> Seth > >> > >> https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo > |
I've spent a few hours digging into this with Seth, and can report that
this makes working on the docs much less of a chore. +1 (with enthusiasm) Best, David On Thu, Jan 14, 2021 at 1:34 PM Kostas Kloudas <[hidden email]> wrote: > +1 for moving to Hugo. > > Cheers, > Kostas > > On Thu, Jan 14, 2021 at 1:27 PM Wei Zhong <[hidden email]> wrote: > > > > +1 for migrating to Hugo. > > > > Currently we have developed many plugins based on Jekyll because the > native features of Jekyll cannot meet our needs. It seems all of them can > be supported via Hugo shortcodes and will become more concise. > > > > Best, > > Wei > > > > > 在 2021年1月14日,18:21,Aljoscha Krettek <[hidden email]> 写道: > > > > > > +1 > > > > > > The build times on Jekyll have just become to annoying for me. I > realize that that is also a function of how we structure our documentation, > and especially how we construct the nav sidebar, but I think overall moving > to Hugo is still a benefit. > > > > > > Aljoscha > > > > > > On 2021/01/13 10:14, Seth Wiesman wrote: > > >> Hi All, > > >> > > >> I would like to start a discussion for FLIP-157: Migrating the Flink > docs > > >> from Jekyll to Hugo. > > >> > > >> This will allow us: > > >> > > >> - Proper internationalization > > >> - Working Search > > >> - Sub-second build time ;) > > >> > > >> Please take a look and let me know what you think. > > >> > > >> Seth > > >> > > >> > https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo > > > |
Happy to see there is enthusiasm for this change, let me try and answers
each of these questions. @Jark Wu <[hidden email]> Hugo has proper support for i18n which means we can move content into external files that can be easily translated[1]. For reference, Kubernetes has successfully used Hugo's built-in features to maintain 14 different languages[2]. Additionally, Hugo's md files are standard markdown which could allow us to integrate with other tooling. For example, we may look into using Crowdin for managing translations as the pulsar community does. @Till Rohrmann <[hidden email]> None that I have found. In the proof of concept, I have already implemented all the Jekyll functionality we are using in the docs[4]. I have found Hugo shortcodes to be a more flexible alternative to liquid tags. @Chesnay Schepler <[hidden email]> Not yet, I do not have access to the build bot (it is PMC only). I will work with INFRA to get Hugo installed if it is not already and Robert has agreed to set-up the build script on the build bot itself. Seth [1] https://gohugo.io/functions/i18n/ [2] https://github.com/kubernetes/website/ [3] https://github.com/apache/pulsar-translation [4] https://github.com/sjwiesman/flink-docs-v2/tree/master/layouts/shortcodes On Thu, Jan 14, 2021 at 7:03 AM David Anderson <[hidden email]> wrote: > I've spent a few hours digging into this with Seth, and can report that > this makes working on the docs much less of a chore. > > +1 (with enthusiasm) > > Best, > David > > On Thu, Jan 14, 2021 at 1:34 PM Kostas Kloudas <[hidden email]> wrote: > > > +1 for moving to Hugo. > > > > Cheers, > > Kostas > > > > On Thu, Jan 14, 2021 at 1:27 PM Wei Zhong <[hidden email]> > wrote: > > > > > > +1 for migrating to Hugo. > > > > > > Currently we have developed many plugins based on Jekyll because the > > native features of Jekyll cannot meet our needs. It seems all of them can > > be supported via Hugo shortcodes and will become more concise. > > > > > > Best, > > > Wei > > > > > > > 在 2021年1月14日,18:21,Aljoscha Krettek <[hidden email]> 写道: > > > > > > > > +1 > > > > > > > > The build times on Jekyll have just become to annoying for me. I > > realize that that is also a function of how we structure our > documentation, > > and especially how we construct the nav sidebar, but I think overall > moving > > to Hugo is still a benefit. > > > > > > > > Aljoscha > > > > > > > > On 2021/01/13 10:14, Seth Wiesman wrote: > > > >> Hi All, > > > >> > > > >> I would like to start a discussion for FLIP-157: Migrating the Flink > > docs > > > >> from Jekyll to Hugo. > > > >> > > > >> This will allow us: > > > >> > > > >> - Proper internationalization > > > >> - Working Search > > > >> - Sub-second build time ;) > > > >> > > > >> Please take a look and let me know what you think. > > > >> > > > >> Seth > > > >> > > > >> > > > https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo > > > > > > |
Great, if there aren't any other concerns I will open this up for a vote on
Monday. Seth On Thu, Jan 14, 2021 at 9:03 AM Seth Wiesman <[hidden email]> wrote: > Happy to see there is enthusiasm for this change, let me try and answers > each of these questions. > > @Jark Wu <[hidden email]> Hugo has proper support for i18n which means > we can move content into external files that can be easily translated[1]. > For reference, Kubernetes has successfully used Hugo's built-in features to > maintain 14 different languages[2]. Additionally, Hugo's md files are > standard markdown which could allow us to integrate with other tooling. For > example, we may look into using Crowdin for managing translations as the > pulsar community does. > > @Till Rohrmann <[hidden email]> None that I have found. In the > proof of concept, I have already implemented all the Jekyll functionality > we are using in the docs[4]. I have found Hugo shortcodes to be a more > flexible alternative to liquid tags. > > @Chesnay Schepler <[hidden email]> Not yet, I do not have access to > the build bot (it is PMC only). I will work with INFRA to get Hugo > installed if it is not already and Robert has agreed to set-up the build > script on the build bot itself. > > Seth > > [1] https://gohugo.io/functions/i18n/ > [2] https://github.com/kubernetes/website/ > [3] https://github.com/apache/pulsar-translation > [4] > https://github.com/sjwiesman/flink-docs-v2/tree/master/layouts/shortcodes > > > > On Thu, Jan 14, 2021 at 7:03 AM David Anderson <[hidden email]> > wrote: > >> I've spent a few hours digging into this with Seth, and can report that >> this makes working on the docs much less of a chore. >> >> +1 (with enthusiasm) >> >> Best, >> David >> >> On Thu, Jan 14, 2021 at 1:34 PM Kostas Kloudas <[hidden email]> >> wrote: >> >> > +1 for moving to Hugo. >> > >> > Cheers, >> > Kostas >> > >> > On Thu, Jan 14, 2021 at 1:27 PM Wei Zhong <[hidden email]> >> wrote: >> > > >> > > +1 for migrating to Hugo. >> > > >> > > Currently we have developed many plugins based on Jekyll because the >> > native features of Jekyll cannot meet our needs. It seems all of them >> can >> > be supported via Hugo shortcodes and will become more concise. >> > > >> > > Best, >> > > Wei >> > > >> > > > 在 2021年1月14日,18:21,Aljoscha Krettek <[hidden email]> 写道: >> > > > >> > > > +1 >> > > > >> > > > The build times on Jekyll have just become to annoying for me. I >> > realize that that is also a function of how we structure our >> documentation, >> > and especially how we construct the nav sidebar, but I think overall >> moving >> > to Hugo is still a benefit. >> > > > >> > > > Aljoscha >> > > > >> > > > On 2021/01/13 10:14, Seth Wiesman wrote: >> > > >> Hi All, >> > > >> >> > > >> I would like to start a discussion for FLIP-157: Migrating the >> Flink >> > docs >> > > >> from Jekyll to Hugo. >> > > >> >> > > >> This will allow us: >> > > >> >> > > >> - Proper internationalization >> > > >> - Working Search >> > > >> - Sub-second build time ;) >> > > >> >> > > >> Please take a look and let me know what you think. >> > > >> >> > > >> Seth >> > > >> >> > > >> >> > >> https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo >> > > >> > >> > |
I have tried in my local env, and the build time is really fast.
Looking forward Hugo can help to better cooperate with the translation work. +1 to start a vote. best, Jark On Fri, 15 Jan 2021 at 23:02, Seth Wiesman <[hidden email]> wrote: > Great, if there aren't any other concerns I will open this up for a vote on > Monday. > > Seth > > On Thu, Jan 14, 2021 at 9:03 AM Seth Wiesman <[hidden email]> wrote: > > > Happy to see there is enthusiasm for this change, let me try and answers > > each of these questions. > > > > @Jark Wu <[hidden email]> Hugo has proper support for i18n which means > > we can move content into external files that can be easily translated[1]. > > For reference, Kubernetes has successfully used Hugo's built-in features > to > > maintain 14 different languages[2]. Additionally, Hugo's md files are > > standard markdown which could allow us to integrate with other tooling. > For > > example, we may look into using Crowdin for managing translations as the > > pulsar community does. > > > > @Till Rohrmann <[hidden email]> None that I have found. In the > > proof of concept, I have already implemented all the Jekyll functionality > > we are using in the docs[4]. I have found Hugo shortcodes to be a more > > flexible alternative to liquid tags. > > > > @Chesnay Schepler <[hidden email]> Not yet, I do not have access to > > the build bot (it is PMC only). I will work with INFRA to get Hugo > > installed if it is not already and Robert has agreed to set-up the build > > script on the build bot itself. > > > > Seth > > > > [1] https://gohugo.io/functions/i18n/ > > [2] https://github.com/kubernetes/website/ > > [3] https://github.com/apache/pulsar-translation > > [4] > > > https://github.com/sjwiesman/flink-docs-v2/tree/master/layouts/shortcodes > > > > > > > > On Thu, Jan 14, 2021 at 7:03 AM David Anderson <[hidden email]> > > wrote: > > > >> I've spent a few hours digging into this with Seth, and can report that > >> this makes working on the docs much less of a chore. > >> > >> +1 (with enthusiasm) > >> > >> Best, > >> David > >> > >> On Thu, Jan 14, 2021 at 1:34 PM Kostas Kloudas <[hidden email]> > >> wrote: > >> > >> > +1 for moving to Hugo. > >> > > >> > Cheers, > >> > Kostas > >> > > >> > On Thu, Jan 14, 2021 at 1:27 PM Wei Zhong <[hidden email]> > >> wrote: > >> > > > >> > > +1 for migrating to Hugo. > >> > > > >> > > Currently we have developed many plugins based on Jekyll because the > >> > native features of Jekyll cannot meet our needs. It seems all of them > >> can > >> > be supported via Hugo shortcodes and will become more concise. > >> > > > >> > > Best, > >> > > Wei > >> > > > >> > > > 在 2021年1月14日,18:21,Aljoscha Krettek <[hidden email]> 写道: > >> > > > > >> > > > +1 > >> > > > > >> > > > The build times on Jekyll have just become to annoying for me. I > >> > realize that that is also a function of how we structure our > >> documentation, > >> > and especially how we construct the nav sidebar, but I think overall > >> moving > >> > to Hugo is still a benefit. > >> > > > > >> > > > Aljoscha > >> > > > > >> > > > On 2021/01/13 10:14, Seth Wiesman wrote: > >> > > >> Hi All, > >> > > >> > >> > > >> I would like to start a discussion for FLIP-157: Migrating the > >> Flink > >> > docs > >> > > >> from Jekyll to Hugo. > >> > > >> > >> > > >> This will allow us: > >> > > >> > >> > > >> - Proper internationalization > >> > > >> - Working Search > >> > > >> - Sub-second build time ;) > >> > > >> > >> > > >> Please take a look and let me know what you think. > >> > > >> > >> > > >> Seth > >> > > >> > >> > > >> > >> > > >> > https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo > >> > > > >> > > >> > > > |
+1 for this FLIP.
I tried it out locally, and it works well. Aside from the fact build times, I really like the search feature, which works pretty well. Thanks a lot for the initiative, Seth! On Sun, Jan 17, 2021 at 4:43 PM Jark Wu <[hidden email]> wrote: > I have tried in my local env, and the build time is really fast. > Looking forward Hugo can help to better cooperate with the translation > work. > > +1 to start a vote. > > best, > Jark > > On Fri, 15 Jan 2021 at 23:02, Seth Wiesman <[hidden email]> wrote: > > > Great, if there aren't any other concerns I will open this up for a vote > on > > Monday. > > > > Seth > > > > On Thu, Jan 14, 2021 at 9:03 AM Seth Wiesman <[hidden email]> > wrote: > > > > > Happy to see there is enthusiasm for this change, let me try and > answers > > > each of these questions. > > > > > > @Jark Wu <[hidden email]> Hugo has proper support for i18n which > means > > > we can move content into external files that can be easily > translated[1]. > > > For reference, Kubernetes has successfully used Hugo's built-in > features > > to > > > maintain 14 different languages[2]. Additionally, Hugo's md files are > > > standard markdown which could allow us to integrate with other tooling. > > For > > > example, we may look into using Crowdin for managing translations as > the > > > pulsar community does. > > > > > > @Till Rohrmann <[hidden email]> None that I have found. In the > > > proof of concept, I have already implemented all the Jekyll > functionality > > > we are using in the docs[4]. I have found Hugo shortcodes to be a more > > > flexible alternative to liquid tags. > > > > > > @Chesnay Schepler <[hidden email]> Not yet, I do not have access > to > > > the build bot (it is PMC only). I will work with INFRA to get Hugo > > > installed if it is not already and Robert has agreed to set-up the > build > > > script on the build bot itself. > > > > > > Seth > > > > > > [1] https://gohugo.io/functions/i18n/ > > > [2] https://github.com/kubernetes/website/ > > > [3] https://github.com/apache/pulsar-translation > > > [4] > > > > > > https://github.com/sjwiesman/flink-docs-v2/tree/master/layouts/shortcodes > > > > > > > > > > > > On Thu, Jan 14, 2021 at 7:03 AM David Anderson <[hidden email]> > > > wrote: > > > > > >> I've spent a few hours digging into this with Seth, and can report > that > > >> this makes working on the docs much less of a chore. > > >> > > >> +1 (with enthusiasm) > > >> > > >> Best, > > >> David > > >> > > >> On Thu, Jan 14, 2021 at 1:34 PM Kostas Kloudas <[hidden email]> > > >> wrote: > > >> > > >> > +1 for moving to Hugo. > > >> > > > >> > Cheers, > > >> > Kostas > > >> > > > >> > On Thu, Jan 14, 2021 at 1:27 PM Wei Zhong <[hidden email]> > > >> wrote: > > >> > > > > >> > > +1 for migrating to Hugo. > > >> > > > > >> > > Currently we have developed many plugins based on Jekyll because > the > > >> > native features of Jekyll cannot meet our needs. It seems all of > them > > >> can > > >> > be supported via Hugo shortcodes and will become more concise. > > >> > > > > >> > > Best, > > >> > > Wei > > >> > > > > >> > > > 在 2021年1月14日,18:21,Aljoscha Krettek <[hidden email]> 写道: > > >> > > > > > >> > > > +1 > > >> > > > > > >> > > > The build times on Jekyll have just become to annoying for me. I > > >> > realize that that is also a function of how we structure our > > >> documentation, > > >> > and especially how we construct the nav sidebar, but I think overall > > >> moving > > >> > to Hugo is still a benefit. > > >> > > > > > >> > > > Aljoscha > > >> > > > > > >> > > > On 2021/01/13 10:14, Seth Wiesman wrote: > > >> > > >> Hi All, > > >> > > >> > > >> > > >> I would like to start a discussion for FLIP-157: Migrating the > > >> Flink > > >> > docs > > >> > > >> from Jekyll to Hugo. > > >> > > >> > > >> > > >> This will allow us: > > >> > > >> > > >> > > >> - Proper internationalization > > >> > > >> - Working Search > > >> > > >> - Sub-second build time ;) > > >> > > >> > > >> > > >> Please take a look and let me know what you think. > > >> > > >> > > >> > > >> Seth > > >> > > >> > > >> > > >> > > >> > > > >> > > > https://cwiki.apache.org/confluence/display/FLINK/FLIP-157+Migrate+Flink+Documentation+from+Jekyll+to+Hugo > > >> > > > > >> > > > >> > > > > > > |
Free forum by Nabble | Edit this page |