Add IDE (Eclipse) instructions #231
Conversation
|
Can one of the admins verify this patch? |
README.md
Outdated
| @@ -26,6 +26,24 @@ under that directory will contain instructions on how to run the sample. | |||
|
|
|||
| If desired, you can easily use the Maven Archetype from a Maven capable IDE such as [Eclipse](https://www.eclipse.org/ide). The generated starter code is simply Maven projects. You can easily load, explore and run the code in a Maven capable IDE such as [Eclipse](https://www.eclipse.org/ide). | |||
|
|
|||
| ## Instructions On How To Use Archetypes From An IDE Such As Eclipse | |||
| Install Maven: | |||
There was a problem hiding this comment.
This should not be needed. Eclipse comes with it's own Maven.
README.md
Outdated
| Install Maven: | ||
| Before you can use Maven in Eclipse, you need to install it on your system. You can download Maven from the official website (https://maven.apache.org/download.cgi) and follow the installation instructions. | ||
|
|
||
| Install the Maven Integration for Eclipse: |
There was a problem hiding this comment.
This should not be needed. For Jakarta EE projects, we should specify the Enterprise version of Eclipse.
README.md
Outdated
| Install the Maven Integration for Eclipse: | ||
| The Maven Integration for Eclipse is a plugin that provides integration between Eclipse and Maven. To install the plugin, open Eclipse and go to Help > Eclipse Marketplace. Search for "Maven Integration for Eclipse" and click on the "Install" button. Follow the installation wizard and restart Eclipse when prompted. | ||
|
|
||
| Create a new Maven project: |
There was a problem hiding this comment.
These are generic instructions. Please provide instructions specific to our archetype.
README.md
Outdated
| Create a new Maven project: | ||
| To use an archetype in Eclipse, you need to create a new Maven project and select the archetype you want to use. To do this, go to File > New > Project > Maven > Maven Project. In the "New Maven Project" dialog, select "Create a simple project" and click "Next". Enter the Group Id, Artifact Id, and Version for your project, and then click "Next". In the "Select an Archetype" dialog, choose the archetype you want to use and click "Next". You can browse the available archetypes by clicking the "Add Archetype" button and entering the details of the archetype you want to use. Finally, enter any additional information required by the archetype and click "Finish" to create the project. | ||
|
|
||
| Configure the Maven project: |
There was a problem hiding this comment.
This should not be needed. Eclipse will auto-detect this.
README.md
Outdated
| Configure the Maven project: | ||
| Once you have created the Maven project, you need to configure it to use the archetype. To do this, right-click on the project in the Project Explorer view and select "Maven > Update Project". In the "Update Maven Project" dialog, select the "Force Update of Snapshots/Releases" checkbox and click "OK". This will download and install the archetype and its dependencies. | ||
|
|
||
| Build and run the project: |
There was a problem hiding this comment.
This is too generic. The information here should be specific to our archetype.
|
@m-reza-rahman please review it I have added steps more specific now. |
| @@ -26,6 +26,28 @@ under that directory will contain instructions on how to run the sample. | |||
|
|
|||
| If desired, you can easily use the Maven Archetype from a Maven capable IDE such as [Eclipse](https://www.eclipse.org/ide). The generated starter code is simply Maven projects. You can easily load, explore and run the code in a Maven capable IDE such as [Eclipse](https://www.eclipse.org/ide). | |||
|
|
|||
| ## Instructions On How To Use Archetypes From An IDE Such As Eclipse | |||
There was a problem hiding this comment.
This is still basically generic instructions on how to create a Maven project in Eclipse using Archetypes. It really has nothing about our specific project. This needs to outline the specific steps for our project including what the user needs to do in order to move forward with the generated project. At the current trajectory, I estimate days of work before this PR is ready to merge. Please avoid frivolous PR updates and aim for quality as well as completeness. It needlessly consumes everyone's time on a volunteer led project in repeated PR review cycles.
|
This is still basically generic instructions on how to create a Maven project in Eclipse using Archetypes. It really has nothing about our specific project. This needs to outline the specific steps for our project including what the user needs to do in order to move forward with the generated project, including using a locally installed SNAPSHOT build. This possibly needs to be a separate page with screenshots clearly illustrating the steps in Eclipse to invoke the archetype. In my estimate this is still very far from something that is ready to merge and add to the user experience of the project, particularly anyone new to Eclipse, archetypes and specifically our archetype. This is not mere hours of work to get right, it's days or weeks... |
|
Ok sir will surely be doing more research about it and adding it more in the comment section before the final PR :). |
|
I am trying to do what I can. Please take the time to carefully/completely process feedback already provided and take the PR out of draft status when it is really ready for meaningful review. |
|
|
||
| # If you are using an enterprise version of Eclipse for a Jakarta EE project, you can follow these steps to create a new Maven project with an archetype: | ||
|
|
||
| Open Eclipse and select "File > New > Other..." from the menu bar. |
There was a problem hiding this comment.
Selecting "Other" is unnecessary. Maven has been a top level choice in Eclipse IDE for some time now.
| @@ -26,6 +26,28 @@ under that directory will contain instructions on how to run the sample. | |||
|
|
|||
| If desired, you can easily use the Maven Archetype from a Maven capable IDE such as [Eclipse](https://www.eclipse.org/ide). The generated starter code is simply Maven projects. You can easily load, explore and run the code in a Maven capable IDE such as [Eclipse](https://www.eclipse.org/ide). | |||
|
|
|||
| ## Instructions On How To Use Archetypes From An IDE Such As Eclipse | |||
|
|
|||
| # If you are using an enterprise version of Eclipse for a Jakarta EE project, you can follow these steps to create a new Maven project with an archetype: | |||
There was a problem hiding this comment.
This should be explicit about what the setup pre-requisites are. Here is an example: https://github.com/eclipse-ee4j/cargotracker/wiki/Eclipse-IDE.
| Click "Next". | ||
| In the "New Maven Project" dialog, enter the Group Id, Artifact Id, and Version for your project. | ||
| Click "Next". | ||
| In the "Select an Archetype" dialog, click the "Add Archetype" button. |
There was a problem hiding this comment.
Why is "Add Archetype" needed here? Our archetype will already be in Maven Central or installed as a SNAPSHOT in the local repository.
|
Thanks for the help! |
Add instructions for IDE #116