GitHub user xintongsong added a comment to the discussion: [Feature] Enhance the quickstart experience
Thanks for preparing this, @JinkunLiu . When I proposed the quickstart experience enhancement, what I had in mind was not just documentation improvements, but to actually reduce the steps users need to take in order to get Flink Agents work. To be specific, we may provide a one line command (like `curl -fsSL https://openclaw.ai/install.sh | bash` from [OpenClaw](https://openclaw.ai/) ), which brings up an installation wizard, detects the environments, self-configures as much as possible, and asks the user only for necessary decisions. Regarding your proposal: > Instead of asking users to submit Flink Agents jobs to a standalone Flink > cluster, we might suggest running them in MiniCluster. This may be more > beginner-friendly and aligns with how Flink’s Quick Start works. No entirely sure what do you mean by "Flink's Quick Start". Flink's [First Steps](https://nightlies.apache.org/flink/flink-docs-master/docs/getting-started/local_installation/) provides 3 options, none of the uses the MiniCluster. I personally am not a big fan of Flink's MiniCluster, as it has quite some unique behaviors that are different from other deployment modes and hard to explain. > Provide a archetype Template for user I like this idea. Just want to mention that, the Flink Agents project is still in its preview versions (0.x) and is rapidly evolving. If we introduce the archetype now, we probably also need to frequently update it w.r.t. the breaking changes. Alternatively, we can wait until the project becomes more stable. I've never worked on a archetype, thus not sure how much effort that takes. WDYT? > Installation Section I'd suggest the following structure: ``` # Overview # Install Flink Agents ## Wizard (Recommended) ## Manual # Prepare Your Job ## Maven Dependencies (for Java) ## Maybe a few words for Python? # Execute Your Job ## From IDE (Minicluster) ## To a Flink cluster ``` GitHub link: https://github.com/apache/flink-agents/discussions/555#discussioncomment-15971644 ---- This is an automatically sent email for [email protected]. To unsubscribe, please send an email to: [email protected]
