quarkusio/quarkus

Improve Quarkiverse extension codestart inital doc

Fermée

#35 367 ouverte le 16 août 2023

Voir sur GitHubGuide contributeur
 (3 commentaires) (0 réaction) (0 personne assignée)Java (2 464 forks)batch import
area/codestartsgood first issuehelp wantedkind/enhancement

Métriques du dépôt

Stars
 (12 967 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Le problème indique explicitement les fichiers à modifier : le répertoire de modèle codestart situé dans independent projects/tools/base codestarts/src/main/resources/codestarts/quarkus extension/code/quarkiverse/java/docs/modules/ROOT. La structure de navigation souhaitée s'inspire du nav.adoc de l'extension quarkus web bundler (lien fourni). Étudiez cet exemple et la capture d'écran pour créer une navigation commune avec des pages vides. Il n'y a pas de PR liés ni de questions du mainteneur, donc la tâche est simple.
Stack technique
java
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
AsciiDocQuarkus extension basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80