-
Notifications
You must be signed in to change notification settings - Fork 16
Update Documentation: Enhance documentation of Gradle for Android #13
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
Update Documentation: Enhance documentation of Gradle for Android #13
Conversation
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.
Thanks for the draft! I am definitely +1 for expanding some of the entries to the sections, but, if we go with teaser sections, they should be considerably more polished.
I suggest to:
- Have a small 101 overview of the AGP plugin with 1-2 examples in Kotlin and references to the pages
- Have new pages for Troubleshooting and Performance where we have original content to reference
- Keep just references for the remaining sections
``` | ||
|
||
This command compiles and packages the APK in `debug` mode. Learn more about building Android projects at [Building project](https://developer.android.com/build/building-cmdline). | ||
|
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 would suggest collapsing those for parts to a short overview on this page and references. It can be done with one example in Kotlin and then references to the use-cases
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.
Gradle provides tasks for building your Android projects, including compiling code, packaging APKs, and generating app bundles. Using the **Gradle wrapper**, you can ensure build consistency across environments.
#### Example of Building an APK with Kotlin DSL:
```kotlin
tasks.register("assembleDebug") {
doLast {
println("Building APK in debug mode...")
}
}
This Kotlin example registers a task to build the APK in debug mode. For more detailed steps on building projects and packaging apps, visit the Building Projects Guide.
|
||
|
||
|
||
### **7. Migration Guide** |
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.
Again, not a recipe per se. I would keep a reference until there is substantial content
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.
### **7. Migration Guide** | |
### **7. Migration Guide** | |
With the shift from **Groovy** to **Kotlin DSL** in the Android ecosystem, migrating your build scripts is essential. This guide helps you transition your build configurations and annotation processing from **Kapt** to **KSP**. | |
For detailed steps and best practices, refer to the [official Migration Guide](https://developer.android.com/build/migrate-to-kotlin-dsl). |
@oleg-nenashev Please check for the changes I have made according to the suggestions requested by you. |
Looks like troubleshooting and performance contents haven't been moved yet, right? |
A new readme for troubleshooting page has been added already and some contents have been added too. Edit : Edit - 2 : |
Hope you could merge my contents with the main branch now. |
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 fix indenting of the Kotlin code, and then we are ready to go. I do have some ideas about restructuring the texts, but I will do them in the subsequent PRs
Ok Sir, I'll be doing the changes in some moment. |
Thank you! And no need to use "sir" 😉
…On Thu, Oct 24, 2024, 15:46 Abhiraj Adhikary ***@***.***> wrote:
Ok Sir, I'll be doing the changes in some moment.
—
Reply to this email directly, view it on GitHub
<#13 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAW4RIG54EUVKQKMPDS3GNDZ5D24BAVCNFSM6AAAAABQMXZCM6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMZVGM2DKMRWHE>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
--
*
CONFIDENTIALITY NOTICE*: The contents of this email message, and any
attachments, are intended solely for the addressee(s) and may contain
confidential, proprietary and/or privileged information legally protected
from disclosure. If you are not the intended recipient of this
communication, or if you received this communication by mistake, please
notify the sender immediately and delete this message and any attachments.
If you are not the intended recipient, you are hereby notified that any
use, retransmission, dissemination, copying or storage of this message or
its attachments is strictly prohibited.
|
Corrected to :
Another error was found in (### 8. Troubleshooting AGP) :
}
I hope now it is all set to be merged. |
I feel that addressing you as "Sir" is essential, given the immense seniority and experience you hold in your field. It’s a level of expertise that would take me years to achieve. The way you guided me through the errors, while being so understanding, truly reflects both your humanity and your seniority 😊🙏 |
This is mostly a cultural matter. I mentored quite a lot of students from India, and I know using "Sir" is common there, as well as other gendered titles. Open-source communities are normally informal and many people may get irritated, and many explicitly say to avoid that due to the risk of gender mistakes, e.g. https://google.github.io/gsocguides/student/communication-best-practices , https://zulip.com/development-community/#communication-style . |
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.
Thank you! let's get it landed and improve incrementally
If I had the permission to improve the Readme of the Gradle's original repo also add Gradle's participation in Hacktober 2024, then I would done that after raising a new issue on the same. |
This PR resolves Issue #9 with the following updates:
Gradle Build Overview: Detailed AGP role, build types (debug, release).
Build Management: Flavors, product dimensions, dynamic delivery modules.
Managing Dependencies: Version conflicts, catalogs, Kotlin Multiplatform.
Building Projects: Gradle wrapper, APKs, CI/CD steps.
Optimizing Builds: Build caching, parallel execution, Gradle Daemon.
Extending AGP: Custom plugins, task integration.
Migration Guide: Groovy to Kotlin DSL, Kapt to KSP.
Troubleshooting AGP: Common build issues, bottlenecks.
@oleg-nenashev, please review and merge to the main branch if everything looks good.