...

...

JIRA: 

...

Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).

Motivation

Flink has been using Jekyll for its user documentation since its earliest days. Over the past several years, as the community has grown, we have run up against several limitations with the current setup. In no particular order, these issues include:

...

These issues make it difficult for community members to contribute documentation, the first resource a new user sees when investigating Flink.

Proposed Changes

Migrate the docs in `flink/docs` with hugo a modern build tool. You can view a proof of concept of this migration here. Please follow the steps in the README to build the site locally.

...

Misc page with code

Translate page

Migration

We have built a migration tool that is capable of rewriting most pages of the Flink docs. We will migrate all content and set up proper aliasing for any pages that move to avoid breaking changes. During the migration we will ask the community for a short documentation freeze to not miss any changes. We will perform the migration over the Chinese new year when many committers are on vacation to make this change as unobtrusive as possible.

...