quarkusio/quarkus

Improve Quarkiverse extension codestart inital doc

Open

#35367 opened on Aug 16, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Java (12,967 stars) (2,464 forks)batch import
area/codestartsgood first issuehelp wantedkind/enhancement

Description

Description

It would be nice to have a common nav structure for our guides like this:

Sources: => https://docs.quarkiverse.io/quarkus-web-bundler/dev/ => https://github.com/quarkiverse/quarkus-web-bundler/blob/main/docs/modules/ROOT/nav.adoc?plain=1

Having the preset nav and empty pages would push new extension in this direction

Implementation ideas

For new contributors, this is where the changes needs to happen: https://github.com/quarkusio/quarkus/tree/main/independent-projects/tools/base-codestarts/src/main/resources/codestarts/quarkus-extension/code/quarkiverse/java/docs/modules/ROOT

Contributor guide

Tech stack
java
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
AsciiDocQuarkus extension basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue provides explicit files to modify: the codestart template directory at independent projects/tools/base codestarts/src/main/resources/codestarts/quarkus extension/code/quarkiverse/java/docs/modules/ROOT. The desired nav structure is inspired by the quarkus web bundler extension's nav.adoc (link given). Investigate that example and the screenshot to create a common nav with empty pages. No linked PRs or maintainer questions exist, so the task is straightforward.