GitHub user JinkunLiu edited a discussion: [Feature] Enhance the quickstart experience
## Motivation Enhance the quickstart experience. - Currently, there are too many manual steps, thus chances for users to make mistakes and run into problems. I would like to modify two sections to enhance the Quick Start experience: the **Installation section** and the **Quickstart section**. ## 1. Installation Section The Installation section feels relatively long and somewhat scattered. For users who only want to complete the Quick Start, it may not be necessary to go through every step in detail. I’m considering whether the existing installation steps could be split into two separate sections — Library Installation and Binary Installation — to make the structure and logic clearer.like this: ```markdown # Overview Briefly explain that we support two approaches: - Library Installation - Binary Installation # Library Installation Users can choose one of the following: ## For Java ### Prerequisites ### Maven Dependencies ## For Python ### Prerequisites ### Set Up Python Environment (Recommended) ### Install Flink Agents Package via pip # Binary Installation ## Install Apache Flink ## Configure PYTHONPATH (Python only) ## Install Flink Agents Java Library ## Start Flink Cluster or Submit Job ``` ## 2. Quick Start Section ### 2.1 Provide a archetype Template for user - A Maven archetype for Java users - A Cookiecutter template for Python users I think this would be more elegant than asking users to download the flink-agents source code and run the example. ### 2.2 Delete ‘Submit Flink Agents Job to Standalone Flink Cluster’ Part 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. Perhaps we could organize it like this: ```markdown # Overview # How to Follow Along Provide: - A Maven archetype (Java) - A Cookiecutter template (Python) # Code Walkthrough ``` These are just my personal thoughts; if I’ve misunderstood anything ,please feel free to point it out. GitHub link: https://github.com/apache/flink-agents/discussions/555 ---- This is an automatically sent email for [email protected]. To unsubscribe, please send an email to: [email protected]
