document deployment infrastructure

[tkphd]

Strange that build-and-deploy.yml uses gh-pages, not the default main branch where edits go.

hpc-carpentry.github.io/.github/workflows/build-and-deploy.yml

Line 53 in a1ea1dd

- name: Build and deploy gh-pages branch

Apparently, this is correct (see below), and necessary because this is not a vanilla deployment (i.e., not hosted by GitHub).

[ocaisa]

Yes, this action allows us to do the complicated build processes that are not allowed by vanilla GitHub pages, the action takes the main branch, builds it and then deploys it to gh-pages

[tkphd]

Okaaay... what "complicated build processes" are we up to, and are they necessary?

[ocaisa]

You need to talk to me about 6 months ago when this information was on the tip of my tongue

[reid-a]

Amend this issue to "document this workflow"?

[ocaisa]

I think it has something to do with queries to the GitHub repos and the use of json files

[ocaisa]

Carpentries should know, they do not deploy via GitHub because of these requirements

[ocaisa]

It's because of jekyll-get-json, see a3a475f for a little context