JuliaDocs/Franklin.jl

Add in deploy documentation for GitHub that now need to explicitly pick `gh-pages`

Open

#736 ouverte le 18 déc. 2020

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Julia (1 060 stars) (118 forks)batch import
docseasygood first issue

Description

It used to be done automatically but not anymore it seems. So basically:

  • push
  • go to repo settings, gh-pages and pick gh-pages with root:

Guide contributeur

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.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
GitHub Pages basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90
Direction de recherche
Locate the deployment section in Franklin.jl's documentation (e.g., docs/src/deploy.md). Add a step after the git push instruction that directs users to go to repository settings, select the gh pages branch for GitHub Pages source, and choose root directory. Reference the screenshot in this issue for clarity.