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
Add tutorial "Building a Java application in IntelliJ IDEA" (fixes #62) #70
Conversation
Thank you for your pull request and welcome to our community! To contribute, please sign the Oracle Contributor Agreement (OCA).
To sign the OCA, please create an Oracle account and sign the OCA in Oracle's Contributor Agreement Application. When signing the OCA, please provide your GitHub username. After signing the OCA and getting an OCA approval from Oracle, this PR will be automatically updated. If you are an Oracle employee, please make sure that you are a member of the main Oracle GitHub organization, and your membership in this organization is public. |
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 am just providing my opinions here.
At the end, it's Oracle's Devrel team deciding what to include here (amd how that should be written).
Especially the beginning feels a lot like an advertisment as opposed to an article I would expect on dev.java.
Also, I think that quite a few things are fairly irrelevant to beginners.
This article contains quite a few images which is a strong contrast to many other articles. I don't know how well that fits in.
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
Also I think you haven't added your name as an author. I don't think this is mandatory but I wanted to make sure you know about it being possible. |
@danthe1st Thanks for taking the time to review, I really appreciate it! Please note that I took an existing article on coding with an IDE and used that as an example for the description and the content. An outline of the content was discussed in the proposal (#62). I'll address a few of your comments separately, but ultimately wait for review from Oracle DevRel team on what to change. |
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.
Hi Marit,
I left a few comments on the draft.
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
@danthe1st @ammbra Pushed changes that resolve most but not yet all of the comments. Remaining few I'll think about and make more changes later. |
Also, OCA is in progress. |
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.
These are just minor nitpicks.
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
@ammbra As discussed: Add myself as author |
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Show resolved
Hide resolved
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.
Please check my comments.
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Show resolved
Hide resolved
* update description to cover content * add brief explanation about build tools * add brief explanation about testing * add myself as author * remove section on live templates * update images, add gifs
Hi @ammbra - pushed changes that should resolve all remaining comments in line with what we discussed last week. OCA stil in progress on our end. |
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
I don't really see #70 (comment) being addressed. |
I will wait for @mlvandijk to push some more changes and once this is done, will look into fitting this article in they are own section/series. |
@ammbra - Just pushed the changes as discussed today. |
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 ran the article using the tooling locally, read through it and found a few things, see my comments.
Also, I don't know how I feel about the many links (except the documentation section, each section links to a jetbrains.com
site at least once) in the article but I think it might be fine.
Finally, I still think the introduction feels a bit too much like an advertisment.
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
@ammbra @danthe1st - do either of you want to raise issues for some topics that were mentions as "should have it's own section" during the review? Off the top of my head, this was mentioned for: version control/git, build systems (Maven/Gradle), testing. Once those are available we can link to them from this article / other relevant places. |
I am unsure on whether these should actually be articles as these things are not really a part of Java (especially version control/git). |
Thank you for signing the OCA. |
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.
Hi Marit,
Thank you very much for your patience and for your effort on continously enhancing this article. I left a few comments on what can be further improved. I also resolved some of the conversations.
Once again, thank you and I hope that next version would be the perfect and the last one.
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
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.
Hi @ammbra - I've updated as per your suggestions and did a final review myself, where I made a few small fixes (I've added comments on what & where in this review).
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
app/pages/learn/01_tutorial/01_your-first-java-app/02_building-with-intellij-idea.md
Outdated
Show resolved
Hide resolved
Correct small typos. (a missing . and empty lines after titles)
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.
Looks good to me.
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.
This is great, thank you again @mlvandijk for getting this over the line, @danthe1st for the reviews, and @ammbra for sponsoring. I've reviewed and all looks good! Let's get this PR merged and then I'll get it merged to prod.
Add tutorial for "Building a Java application in IntelliJ IDEA", based on the outline as discussed in #62 with the following additions/changes:
Please let me know what you think / if any changes are needed.
Thanks!