JuliaDocs/Documenter.jl

Formulate a FAQ/troubleshooting page in the docs

Ouverte

#2 138 ouverte le 8 juin 2023

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)Julia (513 forks)batch import
Type: Documentationhelp wanted

Métriques du dépôt

Stars
 (910 étoiles)
Métriques de merge PR
 (Merge moyen 16j 9h) (3 PRs mergées en 30 j)

Description

There are quite a few common pitfalls that come up over and over again. We should really just have a troubleshooting page. Some ideas of what should go there:

  • Docs are generally not deploying?
    • Are things showing up on the gh-pages branch?
    • Is DOCUMENTER_KEY properly set up?
    • Is CI for docs starting at all?
    • Is deploydocs running? If not, what error do you see? If yes, does it show git push to somewhere?
  • master shows up, but not tags?
    • Is TagBot working? Is it using DOCUMENTER_KEY?
    • Can you see the tags in your GHA logs?

Would be good to collect other common errors and issues people run into as well.

Guide contributeur

Direction de recherche
Collectez les pièges courants à partir des issues et des discussions du dépôt, puis organisez les dans une page de dépannage dans la documentation.
Stack technique
Aucun
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.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75