Home Documentation

GitHub

GitHub is a service that stores and manages source code. It is where we store and manage changes for the home-mgmt repository. That repository contains quite a few things:

  • The source code for this documentation.1
  • .contains the source files for this documentation and a complement of tools to make administration tasks easier. scripts used to provision and manage our home lab servers, and a few other tools you might need if you plan to administer the Lab.

What we use it for

The source code for the documentation you are reading is maintained in a GitHub project. Unless you are logged into the GitHub account that owns that project, you will not be able to see it.

  • Storing the home-mgmt repository — all the Markdown notes you’re reading now, plus the lab provisioning scripts, live here.
  • Publishing this documentation — every time a change is pushed to GitHub, it automatically triggers a build that publishes the updated site to docs.cornillaud.com. This is handled by GitHub Actions, a built-in automation feature of GitHub, working in combination with Cloudflare Pages.
  • Version history — GitHub keeps a complete history of every change ever made. If something gets accidentally deleted or broken, it can be recovered.

Our account

Our GitHub account name is corneo. The account is free tier. The home-mgmt repository is private — only Tim can see or change it.

How to access it

The GitHub website is at github.com. Credentials for signing in are in 1Password.

GitHub access from the command line (used when pushing changes from Tim’s Mac or provisioning the lab servers) uses an SSH key stored in the Lab vault in 1Password, under the item named sshkey.github.

What to do if something seems broken

If this documentation site stops updating after a change is made:

  1. Go to github.com/corneo/home-mgmt/actions — this shows the build history.
  2. A green checkmark means the build succeeded. A red ✗ means something went wrong.
  3. If something is red, click it to see what failed, then let Tim know.

If you can’t get into GitHub at all, the credentials are in 1Password.

Footnotes

  1. The documentation is edited using the Obsidian desktop application. ↩

Graph View

Backlinks