gradle / gradle/guides

Community plugin author uses documentation plugins to produce documentation for their plugin

Open
#307 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

@adammurdoch commented on [Tue Sep 05 2017](https://github.com/gradle-guides/gradle-guides-plugin/issues/15)

It should be easy for a community plugin author to use the documentation plugins to produce some HTML documentation about their plugin, without that documentation necessarily being destined for or hosted on `guides.gradle.org`.

The documentation plugins should, perhaps optionally, produce HTML output that is styled to look something like the guide on `guides.gradle.org`. It should also not include the 'guides' logo in this instance.

---

@pioterj commented on [Tue Sep 05 2017](https://github.com/gradle-guides/gradle-guides-plugin/issues/15#issuecomment-327103940)

I agree. This is in line with what @eriwen was thinking too.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inspecting the documentation-plugin implementation and how it currently generates HTML for guides.gradle.org. Define the standalone output path and styling behavior, then verify that community-plugin documentation can be produced without the guides logo or dependency on guides.gradle.org hosting.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.