GispoCoding / master-training-data

Repo for Gispo training materials.
1 stars 0 forks source link

Dedicate a branch for docs and gh pages publishing #20

Closed JuhoErvasti closed 4 months ago

JuhoErvasti commented 5 months ago

GitHub pages should not be published from main. Instead they should be published from a separate branch (like here for example).

Why? The effect in practice would be minor, but in the long term this way of organizing the repo would be better, and more clear with (at least) 3 additional benefits:

  1. Enforce docs as generated content. Docs are not supposed to be modified manually. If they are "hidden" and protected in a separate branch this will not happen even by mistake.
  2. Get rid of GitHub complaining about the cancelled "pages build and deployment" workflow.
  3. Should enable better opportunities to save repo disk space.
JuhoErvasti commented 4 months ago

Resolved in #28