The start of Spark! Tech Resources
Ruby, gems and bundler are very conservative about upgrades.
We are now using pages-gem
and just-the-docs
as our only gem dependencies and, hopefully, it will upgrade more nicely.
The github pages site will update automatically on every commit to main.
The jekyll config is managed in /_config.prod.yml
as you can see in the GitHub Workflow.
The use of a non-standard file is to support a need for a separate config (in the standard place) for dev.
By far the easiest mechanism to make changes.
- Click on the big green "<> Code" button, click to the 2nd tab (Codespaces), click the "+" sign.
- Once it is done warming up, you should be able to open a terminal and run
./launch.sh
. - However, if you get an error about dependencies, run
bundle update
then run./launch.sh
. - Copy the url to your codespace which will look something like
https://obscure-dollop-qsdadASD.github.dev/
- Open a new browser window or tab and paste the url.
- Before hitting enter, modify it to be
https://obscure-dollop-qsdadASD-4000.app.github.dev/
(NOTE: you are adding-4000.app
kind of in the middle).
You should now be able to hit enter and see your changes.
If anyone has any bright ideas about how to make this a launch configuration I would love to include it.
- Install
docker
orpodman
andmake
. - Find the URI for the repo under the big green "<> Code" button.
git clone
the repo somewhere.- Open the folder in VS Code.
- In a terminal run
make build
ormake build-podman
as appropriate. - run
make run
ormake run-podman
. - You should be able to go to a browser and goto http://localhost:4000 and see the site.
- Make a new branch for your changes
- You should not use a fork, as then the preview automation won't work
- Once you are pretty happy with your code, create a PR from your branch (after you pushed to GitHub) and add
WIP
to the begining of the name of the PR. Go to your PR and you should see a link to preview of the site (it can take awhile). When you think everything is correct, delete theWIP
from the name of the PR and tag some reviewers.