carpentries / carpentries/lesson-example
Include forking how-tos?
- Dominant language
- HTML
- Stars
- 65
- Forks
- 167
- PR merge metrics
- No merged PRs in 30d
Description
Wasn't sure if this would be helpful, but it is indeed possible to create/import lessons via forking on GitHub and still have the website get served. If people were interested in adding instructions for this, these are the steps:
``` bash
# fork git repository online
git clone
git checkout gh-pages
git push origin --delete gh-pages
git push origin gh-pages # triggers website rebuild
```
Should `git push origin --delete gh-pages` fail, change your repository's default branch to something besides `gh-pages` (under settings) and try again. If `gh-pages` is the only branch:
- create a dummy branch: `git branch dummy`
- push the dummy branch to GitHub: `git push origin dummy`
- switch the GitHub default branch to `dummy`
- delete gh-pages `git push origin --delete gh-pages`
Contributor guide
Research direction
The issue provides the proposed forking and gh-pages commands, but names no documentation file or test. Start by locating the lesson-template instructions that describe publishing or importing lessons, then compare the existing guidance with these steps. Done means the forking workflow and gh-pages caveat are documented clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100