Gradle Troubleshooting chapter

[oleg-nenashev]

It would be great to start the "Gradle Troubleshooting" chapter that references external tools that are currently not included in the Main Gradle documentation. It could include the following:

• Gradle Doctor - https://github.com/runningcode/gradle-doctor
• OpenTelemetry plugin for Gradle - https://github.com/craigatk/opentelemetry-gradle-plugin
• Gradle Profiler - https://github.com/gradle/gradle-profiler
• Of course, Gradle Build Scan :)
• ... add your favorite tools to the comments!

Steps

• Create the chapter
• Add tools incrementally

Note

Currently we cannot include repositories as documentation sources, so short summary pages for key use-cases are preferable

[Anurag0git]

@oleg-nenashev can you please explain what do you mean by creating chapter, i mean should we create new repo, or file, or do any changes in README or anything else?

[oleg-nenashev]

Basically, a chapter means a new directory, similar to https://github.com/gradle/cookbook/tree/main/docs/ci for CI tools

[anurag-verma-india]

Note

Currently we cannot include repositories as documentation sources, so short summary pages for key use-cases are preferable

Since Gradle doctor has github pages for documentation so can we use these right?

[oleg-nenashev]

Yes, @anurag-verma-india . A good starter would be a list of the references to the tools with a short overview/summary. No need to duplicate content when it is already present somewhere