JuliaDocs/Franklin.jl

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

Open

#736 opened on Dec 18, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)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:

Contributor guide

Tech stack
None
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GitHub Pages basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
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.