jenkinsci / jenkinsci/java-client-api

Bad documentation

Ouverte
#385 1 commentaire 2 réactions 0 personnes assignées Voir sur GitHub
enhancement
Langage dominant
Java
Étoiles
913
Forks
466
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

The http://jenkinsci.github.io/java-client-api/ link leads to a boilerplate, useless website.

How about instead, we publish the javadocs online, so that users can navigate the available classes more quickly?

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Start by checking the current project build and documentation-publishing entry points, then compare the generated output with the boilerplate site at http://jenkinsci.github.io/java-client-api/. Done means the public link serves navigable Java API documentation covering the available classes instead of the boilerplate page.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java
Domaine
documentation
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.