gradle / community

Gradle Community content and Gradle Cookbook. Open for Contributions
https://community.gradle.org/
Other
26 stars 11 forks source link

Gradle Cookbook - Collection of recipes for Gradle end users #42

Open oleg-nenashev opened 3 months ago

oleg-nenashev commented 3 months ago

We would like to introduce a new resource that allows everyone to contribute a solution-based documentation.

Gradle Cookbook is an open-source collection of recipes, guides and examples for the Gradle Build Tool. This is a complementary resource to the Gradle User Manual, which covers core capabilities maintained by the Gradle team.

References

Why and How?

The Gradle Build Tool ecosystem is huge, including many plugins, integrations, developer tools, and other components. Not all of them can be covered in the Gradle User Manual, which represents core documentation maintained for each Gradle release.

Moreover, being tied to the Gradle release contribution process and the release cycle makes it more difficult to contribute there. Even for us, it has been difficult to maintain documentation in such a way, and many pages need to be updated. Kudos to @lkasso for doing that incrementally

So, we decided to build a second resource as an extension to the Gradle User Manual, with the following in mind:

Open Question

Scope

## Tasks
- [x] Initial Skeleton and Contributor Guidelines - #37 and #43
- [x] Migrate Gradle on CI to the Cookbook
- [ ] https://github.com/gradle/community/issues/88
- [ ] https://github.com/gradle/community/issues/89
- [ ] https://github.com/gradle/community/issues/90
- [x] Port https://github.com/gradle/gradle/pull/28406 to the new location
- [ ] Start the Solutions for Android listing
- [ ] Update docs.gradle.org to use the new resource for the migrated content. Maybe, just redirects in the newer versions and `current`
- [ ] Add PDF generation for the cookbook
- [ ] Announce the new resource
oleg-nenashev commented 1 month ago

As discussed with @lkasso , I suggest splitting out the Cookbook to a separate public repo so it can be easily discovered and contributed to