Gradle Cookbook - Collection of recipes for Gradle end users

[oleg-nenashev]

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

• Site: https://community.gradle.org/cookbook
• Discuss: #docs on the Gradle Community Slack

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:

• Gradle Cookbook remains an official resource under community.gradle.org.
  It is not a second-class citizen, just another structure not tied to the Gradle release cycle
• Pages should be focused on offering solutions to end users for particular use cases,
  hence the Cookbook
  We follow the Wiki-alike collaboration style, with a lower barrier to contribution than gradle/gradle. Over time, some sections can get explicit maintainers/reviewers.
• We use Documentation-as-Code, with simple Markdown or Asciidoc files used as a source
• Minimizing duplication. We can include documentation from other sources under the Gradle GitHub organization

Open Question

• Should the final implementation be on a new GitHub repository?
• What content to move over from docs.gradle.org and other resources? We have a draft list.
• What new content do users want to see/contribute?

Scope

Tasks

Beta Give feedback

1. Initial Skeleton and Contributor Guidelines - Add Gradle cookbook to community site #37 and Add Gradle Cookbook landing and Cross-references #43
2. Migrate Gradle on CI to the Cookbook
3. Migrate Gradle for C/C++ to https://github.com/gradle/gradle-native and include this documentation
4. Include Troubleshooting documentation, including Gradle Profiler
5. Include Gradle GitHub Actions documentation under the GitHub Actions integrations page
6. Port Add documentation page on GitLab CI gradle#28406 to the new location
7. Start the Solutions for Android listing
8. Update docs.gradle.org to use the new resource for the migrated content. Maybe, just redirects in the newer versions and current
9. Add PDF generation for the cookbook
10. Announce the new resource

[oleg-nenashev]

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