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

[FLINK-8654][Docs] Extend quickstart docs on how to submit jobs #6084

Closed
wants to merge 1 commit into from

Conversation

medcv
Copy link
Contributor

@medcv medcv commented May 26, 2018

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:

  • Dependencies (does it add or upgrade a dependency): (no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): (no)
  • The serializers: (no)
  • The runtime per-record code paths (performance sensitive): (no)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: (no)
  • The S3 file system connector: (no)

Documentation

  • Does this pull request introduce a new feature? (no)
  • If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)

@medcv
Copy link
Contributor Author

medcv commented May 27, 2018

@zentol Please review

1 similar comment
@medcv
Copy link
Contributor Author

medcv commented May 31, 2018

@zentol Please review

Copy link
Contributor

@zentol zentol left a 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.

@medcv
Copy link
Contributor Author

medcv commented Jun 6, 2018

@zentol yes, that also works. Do you still need me to change it and extend Next Steps or we can keep this to provide a bit more info for different ways to submitting jobs.

@zentol
Copy link
Contributor

zentol commented Jun 11, 2018

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 Next Steps section does.

@medcv
Copy link
Contributor Author

medcv commented Jun 11, 2018

@zentol sure, will update the PR shortly!

@medcv
Copy link
Contributor Author

medcv commented Jun 26, 2018

@zentol PR has been updated! Please review.

Copy link
Contributor

@zentol zentol left a 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.
Copy link
Contributor

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.

asfgit pushed a commit that referenced this pull request Jul 3, 2018
@asfgit asfgit closed this in 8c15d37 Jul 3, 2018
asfgit pushed a commit that referenced this pull request Jul 3, 2018
sampathBhat pushed a commit to sampathBhat/flink that referenced this pull request Jul 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants