Thank you all for your feedback. If no one has objections, I will continue working according to the plan. I will be sharing the progress updates in the dev list.
Thanks, Aizhamal On Tue, Jan 28, 2020 at 7:42 PM Kenneth Knowles <[email protected]> wrote: > Technical clarification: Docsy is a set of templates for Hugo. The > advantages of Hugo over Jekyll are many. > > - Its tagline is that it is faster. For large sites maybe that matters > more, but for us I don't think it matters much. At least not when I'm > working on the site it hasn't. > - Community/vibrance: At this point it is about equal or slightly > surpassed Jekyll in GitHub stars & forks, etc, so Hugo is thriving. But > they both are. > - I've particularly heard it is better for i18n. I think it is important > for inclusion to have a space set aside for other languages, even before > they are contributed or before you are sure there will be demand. > - Hugo is easier to get started with, no Ruby stuff which is a huge pain > and is why we have this docker build for the website (which I don't use > because I don't have my laptop set up for it). Just simpler. That's good > for encouraging community contributions. And that is a good starting point > for a lot of contributors. > > I'm all for it. And I think using a great set of templates from a major > vendor (Google) is a pretty darn good idea. So, big +1 for Hugo and Docsy > from me. > > Kenn > > > On Mon, Jan 27, 2020 at 3:50 PM Heejong Lee <[email protected]> wrote: > >> >> On Mon, Jan 27, 2020 at 11:19 AM Aizhamal Nurmamat kyzy < >> [email protected]> wrote: >> >>> Hi Alexey, >>> >>> Answers are inline: >>> >>> Do we have any user demands for documentation translation into other >>>> languages? I’m asking this because, in my experience, it’s quite tough work >>>> to translate everything and it won’t be always up-to-date with the >>>> mainstream docs in English. >>>> >>> >>> We know of at least one user who has been trying to grow a Beam >>> community in China and translate the documentation with the local community >>> help: >>> --> https://github.com/mybeam/Apache-Beam-/tree/master/website >>> --> >>> https://lists.apache.org/thread.html/6b7008affee7d70aa0ef13bce7d57455c85759b0af7e08582a086f53%40%3Cdev.beam.apache.org%3E >>> >>> This would hopefully unblock other contributors. For translations, the >>> idea is that the source of truth is the english version, and we'll make >>> sure it's visible on the header of translated pages, as well as dates for >>> the latest updates. >>> >> >> +1 >> >> I think localized contents help non-english speaking users a lot to spark >> the interest even if the contents are somewhat out-of-date. >> >> >>> >>> Also, moving to another doc engine probably will require us to change a >>>> format of mark-up language or not?. What are the other advantages of Docsy >>>> over Jekyll? >>>> >>> >>> We will have to make small tweaks to the Jekyll MD files, but as Brian >>> pointed out in the old thread we can use some tools to automate the process: >>> --> https://gohugo.io/commands/hugo_import_jekyll/ >>> >>> I’d also suggest to improve Beam site context search to be able to >>>> differentiate search queries over user documentation and/or API references. >>>> >>> +1. Will add this as a work item. >>> >>>
