Improve Building from Source Instructions #2257
Conversation
Add a note to the Building From Source instructions to indicate that Python 3 is a requirement for building the archetype-lambda project. Add section about code generation and a tip to help IntelliJ IDEA users on how to fix class not found errors for generated code.
…improve-build-instructions
Codecov Report
@@ Coverage Diff @@
## master #2257 +/- ##
=========================================
Coverage 77.62% 77.63%
Complexity 367 367
=========================================
Files 1237 1237
Lines 38904 38904
Branches 3064 3064
=========================================
+ Hits 30201 30204 +3
+ Misses 7239 7236 -3
Partials 1464 1464
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
|
By the way, it did occur to me that entire contents of Building From Source should be move to |
|
I made a few more updates based on testing the behavior by starting from scratch a few times. |
|
Kudos, SonarCloud Quality Gate passed!
|
|
Hi @helloworldless, thank you for your time and effort to work on improving the docs! 🙂 We will take a look shortly. |
| @@ -116,16 +116,51 @@ See the [Set up the AWS SDK for Java][docs-setup] section of the developer guide | |||
|
|
|||
| Once you check out the code from GitHub, you can build it using Maven. | |||
|
|
|||
| Note: The `archetypes/archetype-lambda` project requires that you have Python 3 in your path as `python`. | |||
There was a problem hiding this comment.
Can you add this info in the archetype-lambda README instead of the main README?
https://github.com/aws/aws-sdk-java-v2/blob/master/archetypes/archetype-lambda/README.md
| `target/generated-sources` of many of the projects in this repo. | ||
|
|
||
| In IntelliJ IDEA, the default setting of "Generated sources folders: Detect automatically" | ||
| under `File | Settings | Build, Execution, Deployment | Build Tools | Maven | Importing` should suffice. |
There was a problem hiding this comment.
I would avoid giving super specific instructions on menu paths because they can vary - for example, in my IntelliJ the Build, Execution, Deployment menu is not under File | Settings but under Preferences.
Maybe just mention Build, Execution, Deployment | Build Tools | Maven | Importing? Or maybe instruct to search Build Tools in the Search tool.
|
Going to close this for now since it hasn't been updated in some time. Please feel free to reopen it once the previous feedback has been addressed 😄 . |
…337a39a6c Pull request: release <- staging/84cb5c82-1de3-4c88-8120-0a4337a39a6c
Description
Improve Building from Source Instructions
Motivation and Context
Making a few things more explicit to help newcomers to the project. This is based on my own experience struggling with this a bit. I hope it will help others in the future.
Previously, the first command encountered under Building From Source was
mvn clean install. It's highly likely that a newcomer will run the first command they see, and in my case, I ended up waiting 10 mins only for the build to fail. So this command is not a good option to lead with. For that reason, I created separate sections for building a single sub-project and building the whole project and made sure that the single sub-project section comes first.Testing
N/A
Types of changes
Documentation (
README) change onlyChecklist
mvn installsucceedsLicense