Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: flow dev guide #959

Merged
merged 8 commits into from
May 16, 2024
Merged

docs: flow dev guide #959

merged 8 commits into from
May 16, 2024

Conversation

discord9
Copy link
Contributor

What's Changed in this PR

Describe the change in this PR

Flow's dev guide, including flow's compute module and state management

Checklist

  • Please ensure that the content in summary.yml matches the current document structure when you changed the document structure.
  • This change requires follow-up update in localized docs.

@nicecui nicecui changed the title Flow dev guide docs: flow dev guide May 16, 2024
@nicecui
Copy link
Collaborator

nicecui commented May 16, 2024

In which component is the flownode located? Frontend? Datanode? or Metasrv?
We can move the flownode documents to the component documentation where it belongs to.

@nicecui
Copy link
Collaborator

nicecui commented May 16, 2024

please also update the summary.yml, thank you

Comment on lines 1 to 3
# Arrangement

Arrangement store the state in the dataflow's process, for now there is no persisent and we store arrangement in the memory. The arrangement essentially store key-value pairs with timestamp to mark it's change time.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe state what's "arrangement" first.


The kv pairs are both `Row` in arrangement, and the timestamp is the time when the row is created or updated.

internally, arrangement get tuples like
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
internally, arrangement get tuples like
Internally, arrangement get tuples like

docs/nightly/en/contributor-guide/flownode/arrangement.md Outdated Show resolved Hide resolved
Copy link

cloudflare-workers-and-pages bot commented May 16, 2024

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 009a027
Status: ✅  Deploy successful!
Preview URL: https://28e80576.greptime-docs.pages.dev
Branch Preview URL: https://flow-dev-guide.greptime-docs.pages.dev

View logs

@discord9 discord9 marked this pull request as ready for review May 16, 2024 08:40
@discord9 discord9 requested review from nicecui and a team as code owners May 16, 2024 08:40
Copy link
Collaborator

@nicecui nicecui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also modify the architecture image in /contributor-guide/overview.md. cc @fengjiachun

docs/nightly/en/contributor-guide/flownode/overview.md Outdated Show resolved Hide resolved
docs/nightly/en/contributor-guide/flownode/overview.md Outdated Show resolved Hide resolved
docs/nightly/en/contributor-guide/flownode/overview.md Outdated Show resolved Hide resolved
docs/nightly/en/contributor-guide/flownode/overview.md Outdated Show resolved Hide resolved
docs/nightly/en/contributor-guide/flownode/overview.md Outdated Show resolved Hide resolved
docs/nightly/en/contributor-guide/flownode/arrangement.md Outdated Show resolved Hide resolved
docs/nightly/en/contributor-guide/flownode/dataflow.md Outdated Show resolved Hide resolved
docs/nightly/en/contributor-guide/flownode/dataflow.md Outdated Show resolved Hide resolved
docs/nightly/en/contributor-guide/flownode/dataflow.md Outdated Show resolved Hide resolved
docs/nightly/en/contributor-guide/flownode/dataflow.md Outdated Show resolved Hide resolved
@WenyXu WenyXu mentioned this pull request May 16, 2024
13 tasks
@fengjiachun
Copy link
Contributor

Please also modify the architecture image in /contributor-guide/overview.md. cc @fengjiachun

I think we don't need to add the flow engine to the architecture diagram for now.

Copy link
Contributor

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@nicecui nicecui merged commit 2f44146 into main May 16, 2024
4 checks passed
@nicecui nicecui deleted the flow_dev_guide branch May 16, 2024 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants