Skip to content

Fix QuickStart README Instructions#11

Merged
milindsrivastava1997 merged 5 commits into
mainfrom
8-fix-quickstart-readme-instructions
Oct 28, 2025
Merged

Fix QuickStart README Instructions#11
milindsrivastava1997 merged 5 commits into
mainfrom
8-fix-quickstart-readme-instructions

Conversation

@STWMichael
Copy link
Copy Markdown
Contributor

Fixed QuickStart to include changes that need to be made for the job to successfully run.

@STWMichael STWMichael self-assigned this Oct 28, 2025
@STWMichael STWMichael linked an issue Oct 28, 2025 that may be closed by this pull request
Comment thread README.md Outdated
Copy the code from [QuickStart.java](flinksketch-examples/src/main/java/dev/projectasap/flinksketch/examples/quickstart/QuickStart.java) to `src/main/java/com/mycompany/app/App.java`.
Copy the code from [QuickStart.java](flinksketch-examples/src/main/java/dev/projectasap/flinksketch/examples/quickstart/QuickStart.java) to `src/main/java/com/mycompany/app/App.java`, and make these changes:
- Change the package from `package dev.projectasap.flinksketch.examples.quickstart;` to `package com.mycompany.app;`
- Rename the class from `public class QuickStart` to `public class App`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we just keep it as QuickStart.java? That way the user has to change one less thing for the quickstart.

Comment thread README.md Outdated
### 4. Write Your Flink Job

Copy the code from [QuickStart.java](flinksketch-examples/src/main/java/dev/projectasap/flinksketch/examples/quickstart/QuickStart.java) to `src/main/java/com/mycompany/app/App.java`.
Copy the code from [QuickStart.java](flinksketch-examples/src/main/java/dev/projectasap/flinksketch/examples/quickstart/QuickStart.java) to `src/main/java/com/mycompany/app/App.java`, and make these changes:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Explicitly mention the file path of QuickStart.java so the user can easily run a cp command

@milindsrivastava1997 milindsrivastava1997 merged commit adcaf10 into main Oct 28, 2025
4 checks passed
@milindsrivastava1997 milindsrivastava1997 deleted the 8-fix-quickstart-readme-instructions branch October 28, 2025 20:02
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.

Fix QuickStart README Instructions

2 participants