← Back to issue list

docs: group plugins by language

View original Github issue

Metadata

Project
craft-parts
Number
#1650
Type
pull request
State
open
Author
GreyViperTooth
Labels
—
Created
Updated
Closed
—

Current evaluation

Groups plugins reference documentation into categories (Utility, Language-agnostic, Language-specific, Offline build plugins). Under review with 10 unresolved comments; 2 CI checks failing (lint/files, test-common minimum dependencies).

Suggested action: keep open

Reason: The PR is under active review with 10 unresolved review comments and 2 failing CI checks (lint/files, test-common minimum dependencies). The author has been responsive to feedback (dropped source reorganization per @steinbro's suggestion, updated grouping structure per discussion with @medubelko, @bepri, @lengau). Last activity was 5 days ago, so it is not abandoned. The PR needs the CI failures addressed and review comments resolved before it can be merged.

Evaluated by: mr-cal-bot

Impact: 20 Quick Win: 7 Complexity: 15 Confidence: 75 Actionability: 40

Issue body

Group plugins by the language or technology they support, in both the documentation and the source tree. **Documentation** (first commit): the plugins reference index is organized into nine groups — Built-in, Multi-language, .NET, Go, Java, JavaScript, Python, Ruby, and Rust — each with a short description, instead of one flat alphabetical list. Page URLs are unchanged. **Source** (second commit): plugin modules move into per-language subpackages that mirror the documentation groups (for example `craft_parts/plugins/python/python_plugin.py`). Every previous module path remains importable through a compatibility alias module with explicit re-exports, so applications that do `from craft_parts.plugins import python_plugin` (as Snapcraft and Rockcraft do) are unaffected. A new unit test (`tests/unit/plugins/test_module_aliases.py`) checks for that guarantee. The `python_v2` package is already grouped and stays where it is. This change was developed with the assistance of an AI tool (Claude Fable 5). I have reviewed and tested all of it before making the commits. Fixes #1571

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b
Impact: 20
Quick Win: 7
Complexity: 15
Confidence: 75
Actionability: 40
keep open Groups plugins reference documentation into categories (Utility, Language-agnostic, Language-specific, Offline build plugins). Under review with 10 unresolved comments; 2 CI checks failing (lint/files, test-common minimum dependencies).
stealth/space-bunny-alpha
Impact: 22
Quick Win: 8
Complexity: 25
Confidence: 62
Actionability: 50
needs review Originally grouped plugins by language in docs plus a per-language source tree split; after steinbro's feedback the author rebased to a docs-only change (grouped plugins.rst index + how-to note). Awaiting medubelko's docs-structure review; 2 CI checks fail.
stealth/space-bunny-alpha
Impact: 24
Quick Win: 11
Complexity: 18
Confidence: 84
Actionability: 55
needs review Groups the plugin reference index by language (Built-in, .NET, Go, Java, JS, Python, Ruby, Rust) in docs. Source-reorg commit was dropped at maintainer request; now docs-only, awaiting review.
stealth/space-bunny-alpha
Impact: 25
Quick Win: 15
Complexity: 15
Confidence: 95
Actionability: 72
needs review Reorganizes the plugin reference into nine language and technology groups and updates a plugin how-to. CLA passes; no checks fail, but maintainer assessment of the ongoing docs structure is pending.
qwen3.6-35b-a3b-mtp-q6
Impact: 25
Quick Win: 21
Staleness: 45
Complexity: 15
Confidence: 75
needs review Groups plugins by language in docs/reference/plugins.rst. Simplified per maintainer feedback to docs-only change. Waiting for second reviewer (medubelko) to assess fit with ongoing docs changes.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 10
Confidence: 90
needs review Organizes plugin documentation by language to improve navigation. Maintainer requested dropping source reorganization; PR now contains only docs changes. Awaiting maintainer review.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 10
Confidence: 90
needs review Groups plugins by language in the documentation index. Maintainer requested dropping source reorganization; author updated branch to only include docs changes. Awaiting maintainer review.
qwen3.6-35b-a3b-mtp-q6
Staleness: 5
Complexity: 45
Confidence: 85
needs review Refactors plugin modules into language-specific subpackages and reorganizes documentation. Maintains backward compatibility via re-export aliases. Currently awaiting maintainer review with no comments or activity yet.

Update history

Date Change
updated
updated
updated
updated
updated
updated
updated
updated
updated
updated

Related work

  • Related To: craft-parts#1571 (confidence 90%)

    This PR fixes #1571 by organizing the plugins reference documentation into grouped categories as originally proposed in that issue.

Related issues

Issue Project State Summary Similarity
#1571 Group related plugins craft-parts open Group craft-parts plugins by language in docs (and optionally in source layout). Categorization agreed with a volunteer contributor who is preparing a PR; docs/plugins.rst toctree is still flat.
73%