Hacktoberfest 2024 - Contributing to Gradle Documentation
In this session, Laura Kassovic and Oleg Nenashev from the Gradle Build Tool Engineering Team will show how to contribute to Gradle documentation and what tools we have! This session might be useful to any writer or developer who is interested in Documentation as Code in open source.
User and Developer documentation is an essential part of the Gradle user experience. Most of Gradle Build Tool documentation is open source. We continuously improve the documentation to stay up to date with new features and use cases, and we welcome contributions of any size. From minor typo fixes to new solution pages, you can help the project and millions of its users!
What’s under the hood? As with other big open-source projects, we use a diverse set of tools for documentation development: Markdown and Asciidoc for writing; MkDocs, Jekyll, and the Gradle Asciidoc Plugin as documentation engines; and many tools like Dev Containers to provide a great writer experience. Additionally, we utilize other tools such as Dokka, Javadoc, and OpenAPI specifications. Sounds familiar? Then join this event!
References:
https://community.gradle.org/contribu...
https://community.gradle.org/events/h...
#docs on the Community Slack
Sections
00:00 Opening
01:00 Hacktoberfest in Gradle
02:00 Why is it important to contribute to the documentation?
07:38 Key doc locations in Gradle
14:11 Contributing to Gradle User Manual
21:30 Ideas for Contribution
21:51 Gradle Cookbook and MkDocs sites under the hood
25:42 Small documentation patches in GitHub Web UI
30:46 Local documentation developer environment
37:55 Ideas for Contribution - 2
42:05 Call for Contributions: Gradle CookBook
43:55 Summary and References
