gradle / gradle/guides

Reduce duplication of plugin publishing guides

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

There's an obvious duplication between help pages at https://plugins.gradle.org/docs/submit and https://plugins.gradle.org/docs/publish-plugin vs more throughout and step-by-step guide at https://guides.gradle.org/publishing-plugins-to-gradle-plugin-portal/. We could point the documentation from the plugin portal to the appropriate guide to avoid it.

@etiennestuder @ldaley Any interest from your side to make such change at this point in time? Even though it's a minor, someone familiar with the Plugin Portal from your team would have to be involved. @ysb33r wrote this guide and could make changes in it with needed, so from that perspective it's a good timing. After July we will be on our own.

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare the Plugin Portal pages at plugins.gradle.org/docs/submit and /docs/publish-plugin with the guide at guides.gradle.org/publishing-plugins-to-gradle-plugin-portal/. Start by identifying duplicated publishing instructions and determine where the portal pages should link to the guide. Done means the duplicated guidance is removed or reduced and readers are directed to the appropriate step-by-step guide.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.