{"id":18299633,"url":"https://github.com/containersolutions/runbooks","last_synced_at":"2025-06-25T07:06:23.636Z","repository":{"id":46778894,"uuid":"266078550","full_name":"ContainerSolutions/runbooks","owner":"ContainerSolutions","description":"A collection of step by step guides for fixing common tech problems.","archived":false,"fork":false,"pushed_at":"2023-02-13T22:09:55.000Z","size":2424,"stargazers_count":128,"open_issues_count":18,"forks_count":48,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-05-06T03:38:44.654Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://containersolutions.github.io/runbooks/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ContainerSolutions.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-05-22T10:03:22.000Z","updated_at":"2025-02-21T07:37:23.000Z","dependencies_parsed_at":"2023-02-14T16:15:46.053Z","dependency_job_id":null,"html_url":"https://github.com/ContainerSolutions/runbooks","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ContainerSolutions/runbooks","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Frunbooks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Frunbooks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Frunbooks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Frunbooks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ContainerSolutions","download_url":"https://codeload.github.com/ContainerSolutions/runbooks/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Frunbooks/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261823754,"owners_count":23215142,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T15:09:41.596Z","updated_at":"2025-06-25T07:06:23.607Z","avatar_url":"https://github.com/ContainerSolutions.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Runbooks\n\n## The Manifesto\n\n- We are tired of haphazardly hunting through messy threads of GitHub issues and StackOverflow when we hit a problem\n\n- We don't want a one-off fix, we want to deepen our understanding of the problem space\n\n- We want to give people a resource where they can benefit from our experience in a scalable way\n\n## What\n\nA collection of step by step guides for fixing common tech problems.\n\nThe content is published [here](https://containersolutions.github.io/runbooks/)\n\n## Requirements\n\n### Submodules\n\nHugo uses submodule for themes so when you are cloning this repository you should pass the `--recursive` flag:\n\n```\ngit clone --recursive git@github.com:ContainerSolutions/runbooks.git\n```\n\n## Running hugo locally\n\n### Docker\n\nIf you have docker compose installed you can simply call and you should see the blog at http://localhost:1313/runbooks/\n\n```\n$ docker-compose up\n```\n\nAlternatively, without docker compose:\n\n```\n$ docker build -t runbooks-hugo .\n...\n$ docker run -v $PWD:/src -p 1313:1313 -d runbooks-hugo\n```\n\n#### Local Install (runs really fast)\n\nFirst [install hugo](https://gohugo.io/getting-started/installing/) then from this repository run:\n\n```\nhugo serve -D\n```\n\n#### Github pages deploy\n\nThe deploy to Github Pages is controlled by [this action](https://github.com/containersolutions/gh-actions-hugo-deploy-gh-pages). The reference to this is found in [.github/workflows/main.yml](https://github.com/ContainerSolutions/runbooks/blob/80767a47c4ed2db5176bea6b489df9069c1282ff/.github/workflows/main.yml#L15).\n\nTo update the key used\n1) create an SSH key and put the private key into a secret called `GIT_DEPLOY_KEY` [here](https://github.com/ContainerSolutions/runbooks/settings/secrets).\n2) add the public key as a deploy key with write access [here](https://github.com/ContainerSolutions/runbooks/settings/keys).\n\nMore granular details are available on the [action page](https://github.com/containersolutions/gh-actions-hugo-deploy-gh-pages#secrets).\n\n## Debugging\n\nThe Hugo docs can occasionally be a bit vague about what methods are available or what they return. There also seems to be quite a bit of [push](https://github.com/gohugoio/hugo/issues/4081#issuecomment-442384273)-[back](https://github.com/gohugoio/hugo/issues/3957#issuecomment-364657015) to adding general debugging tools. One user has created a theme that includes a partial and a shortcode to work around this limitation.\n\nIf you are working from inside a partial or layout file you can include the following partial and pass the property that you wish to inspect. I'm using `.File` in the example below.\n\n    {{ partial \"debugprint.html\" .File }}\n\nThis will show you various properties available via `.File`.\n\nIf working within a content file things are a lot more limited but you can pass the following variants to get appropriate output:\n\n    {{\u003c debug \"params\" \u003e}}\n    {{\u003c debug \"site\" \u003e}}\n    {{\u003c debug param=\"title\" \u003e}}\n\nbut generally you will get more use when invoking the `debugprint` partial directly.\n\n## Adding content\n\nRun:\n\n```\nhugo new posts/path/article-name.md\n```\n\nThen git add, commit, raise PR as normal.\n\n\n## License\n\nSee [LICENSE](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontainersolutions%2Frunbooks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcontainersolutions%2Frunbooks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontainersolutions%2Frunbooks/lists"}