OpenTabletDriver / OpenTabletDriver/opentabletdriver.github.io

Auto deploy of TABLETS.md

Open
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ci enhancement good first issue help wanted
Dominant language
HTML
Stars
36
Forks
10
Avg merge
12h 32m
Merged PRs (30d)
9

Description

Using a submodule isn't (easily) feasible - with the current setup we need the tablets.md file to be located in /_includes as symlinks aren't supported in Jekyll's safe mode, which GitHub Pages enforces.

The external file that needs to be kept updated: https://github.com/OpenTabletDriver/OpenTabletDriver/blob/master/TABLETS.md

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting how the Jekyll site currently populates _includes and how GitHub Pages deployment is configured. Use the external OpenTabletDriver TABLETS.md file as the source; done means the copy in _includes is automatically kept up to date without relying on a submodule or symlink.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll
Domain
build-system, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.