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

Add tutorial "Building a Java application in IntelliJ IDEA" (fixes #62) #70

Merged
merged 13 commits into from Apr 23, 2024

Conversation

mlvandijk
Copy link
Contributor

@mlvandijk mlvandijk commented Mar 12, 2024

Add tutorial for "Building a Java application in IntelliJ IDEA", based on the outline as discussed in #62 with the following additions/changes:

  • "Searching and navigating" (another upside of using an IDE, imho)
  • Version control (which I'm also fine to remove again, if it's not considered beginner friendly enough. I'd already written it so thought I'd include for now)
  • Testing and debugging -> Split into 2 sections, as a. it got too long, and b. its also possible to run the application in debug mode.

Please let me know what you think / if any changes are needed.
Thanks!

Copy link

Thank you for your pull request and welcome to our community! To contribute, please sign the Oracle Contributor Agreement (OCA).
The following contributors of this PR have not signed the 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.

@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Required At least one contributor does not have an approved Oracle Contributor Agreement. label Mar 12, 2024
Copy link
Contributor

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

@danthe1st
Copy link
Contributor

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.

@mlvandijk
Copy link
Contributor Author

mlvandijk commented Mar 13, 2024

@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.
For example, I did notice the option to add my name as an author, but tbh I care more about adding the content then I do about having my name on there. Happy to add it if required.

Copy link
Collaborator

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

@mlvandijk
Copy link
Contributor Author

@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.

@mlvandijk
Copy link
Contributor Author

Also, OCA is in progress.

Copy link
Contributor

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

@mlvandijk
Copy link
Contributor Author

mlvandijk commented Mar 28, 2024

@ammbra As discussed: Add myself as author

Copy link
Collaborator

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

@danthe1st danthe1st mentioned this pull request Apr 2, 2024
* 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
@mlvandijk
Copy link
Contributor Author

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.

@danthe1st
Copy link
Contributor

danthe1st commented Apr 3, 2024

I don't really see #70 (comment) being addressed.
Also I don't see anything coming out of #70 (comment) (most of the Evolving the project is pointless for beginners in my opinion and I don't see any summary).
I still don't agree with it being necessary to make Maven a fundamental part of this tutorial just for the sake of being able to introduce testing but if it is that way, it's fine.
One other thing I noticed is that you wrote macOS a few times with a lowercase m. Is it actually called macOS instead of MacOS?
Aside from that, it might be a good idea to group all IDE articles together similar to how the Classes and Objects section is grouped (to not occlude the /learn page too much) but I will await Ana's decision on that.

@ammbra
Copy link
Collaborator

ammbra commented Apr 4, 2024

I don't really see #70 (comment) being addressed. Also I don't see anything coming out of #70 (comment) (most of the Evolving the project is pointless for beginners in my opinion and I don't see any summary). I still don't agree with it being necessary to make Maven a fundamental part of this tutorial just for the sake of being able to introduce testing but if it is that way, it's fine. One other thing I noticed is that you wrote macOS a few times with a lowercase m. Is it actually called macOS instead of MacOS? Aside from that, it might be a good idea to group all IDE articles together similar to how the Classes and Objects section is grouped (to not occlude the /learn page too much) but I will await Ana's decision on that.

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.

@mlvandijk
Copy link
Contributor Author

@ammbra - Just pushed the changes as discussed today.
@danthe1st - Nice catch on JUnit 5 -> fixed this as well. And yes, it is macOS (see the apple website).

Copy link
Contributor

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

@mlvandijk mlvandijk requested a review from ammbra April 5, 2024 11:57
@mlvandijk
Copy link
Contributor Author

@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.

@danthe1st
Copy link
Contributor

I am unsure on whether these should actually be articles as these things are not really a part of Java (especially version control/git).

Copy link

Thank you for signing the OCA.

@oracle-contributor-agreement oracle-contributor-agreement bot added OCA Verified All contributors have signed the Oracle Contributor Agreement. and removed OCA Required At least one contributor does not have an approved Oracle Contributor Agreement. labels Apr 16, 2024
Copy link
Collaborator

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

Copy link
Contributor Author

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

Correct small typos. (a missing . and empty lines after titles)
Copy link
Collaborator

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

Copy link
Member

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

@ammbra ammbra merged commit 55f6778 into java:main Apr 23, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants