Tracking: Developer Docs

[fuyufjh]

In order to make it easier for community developers to understand the internals, we may migrate some design docs from Quip to this repo under the docs folder.

Unlike Quip, the docs selected is recommended to be relatively stabilized. Discussions should not be placed here.

Please make sure to check the docs before migrating here, including:

• Revise the outdated descriptions
• Clean or update the hyperlink to internal docs or resources
• Complete or rewrite the motivation/context/background to help others to understand
• Revise some inappropriate words (just in case)

The list below is not completed yet. Please feel free to add more or comment.

• docs: Streaming overview #1407
• docs: State Store overview #1410
• docs: Architecture Design #1408
• docs: Metadata Service #1409
• docs: Create MView on MView #1406
• design docs: Checkpoint & Barrier & Consistency Design #1763
• design docs: Design of Data Source #1762
• Data model and Row format
• Docs: Local state and cache of stateful operator #1520

[TennyZhuang]

I’d like to move docs written by me. Next time for sure!

[skyzh]

shall we have a ToC under docs folder?

[fuyufjh]

shall we have a ToC under docs folder?

Yes, there is a TODO in the docs/README.md