-
Notifications
You must be signed in to change notification settings - Fork 13.1k
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
[FLINK-8654][Docs] Extend quickstart docs on how to submit jobs #6084
Conversation
@zentol Please review |
1 similar comment
@zentol Please review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You could've saved a lot of time by extending the Next steps
section and linking to the setup_quickstart
page.
@zentol yes, that also works. Do you still need me to change it and extend |
Ideally we only link to other sections, otherwise we end up with redundant (and probably inconsistent) information in the docs. You can link to specific sections for each way to submit jobs, similar to what the existing |
@zentol sure, will update the PR shortly! |
@zentol PR has been updated! Please review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
merging.
@@ -111,7 +111,7 @@ In IntelliJ IDEA recommended way to change JVM options is from the `Help | Edit | |||
## Build Project | |||
|
|||
If you want to __build/package your project__, go to your project directory and | |||
run the '`mvn clean package`' command. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it actually looks nicer with the ticks. https://ci.apache.org/projects/flink/flink-docs-master/quickstart/java_api_quickstart.html#build-project
Will revert this while merging.
This closes apache#6084. This closes apache#6047.
Brief change log
The quickstart documentation explains how to setup the project, build the jar and run things in the IDE, but neither explains how to submit the jar to a cluster nor guides the user to where he could find this information (like the CLI docs).
Does this pull request potentially affect one of the following parts:
@Public(Evolving)
: (no)Documentation