gradle / gradle/guides

Requesting gradle-guides-plugin html resource template documenation

Open
#355 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
48
Forks
36
Avg merge
7h 37m
Merged PRs (30d)
8

Description

Hi I am looking at the [gradle-guides-plugin](https://github.com/gradle/guides/tree/master/subprojects/gradle-guides-plugin) and I see the head, header, footer templates in src/main/resources, however
1. There are no specific plugin docs on how they will be included during asciidocter conversion
2. How I can i**nclude more templates like tips.html** and if I do so, how they will be processed and included in generated HTML?

Can someone please improvise docs. I have posted a question at [forums ](https://discuss.gradle.org/t/gradle-guides-plugin-html-custom-templates/35733) on the same.

Also please see memory and cpu consumption (which is very very peak --> Never saw this before on my rig) when I ran `gradle clean guidesMultiPage installGuides`

![image](https://user-images.githubusercontent.com/794212/79628199-de74ab00-810c-11ea-8dac-eca44d8c9885.png)

best,
sanumala

Contributor guide

No contributing guide indexed for this repository

Research direction

Start in subprojects/gradle-guides-plugin and inspect src/main/resources alongside the Asciidoctor conversion used by guidesMultiPage. Document how the head, header, and footer templates are included and how an additional tips.html template would be processed; verify the explanation with gradle clean guidesMultiPage installGuides.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.