{"id":51148236,"url":"https://github.com/pbsladek/tech-study-guide","last_synced_at":"2026-06-26T04:01:09.752Z","repository":{"id":359869702,"uuid":"1242803213","full_name":"pbsladek/tech-study-guide","owner":"pbsladek","description":"A searchable Jekyll study guide for infrastructure, networking, databases, Linux, Kubernetes, DNS, identity, and related engineering topics.","archived":false,"fork":false,"pushed_at":"2026-05-23T20:30:35.000Z","size":2975,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-23T22:17:21.212Z","etag":null,"topics":["jekyll","study","study-guide"],"latest_commit_sha":null,"homepage":"https://pbsladek.github.io/tech-study-guide/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pbsladek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-05-18T19:15:11.000Z","updated_at":"2026-05-23T20:33:19.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/pbsladek/tech-study-guide","commit_stats":null,"previous_names":["pbsladek/tech-study-guide"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/pbsladek/tech-study-guide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pbsladek%2Ftech-study-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pbsladek%2Ftech-study-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pbsladek%2Ftech-study-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pbsladek%2Ftech-study-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pbsladek","download_url":"https://codeload.github.com/pbsladek/tech-study-guide/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pbsladek%2Ftech-study-guide/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34802385,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-26T02:00:06.560Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["jekyll","study","study-guide"],"created_at":"2026-06-26T04:01:02.077Z","updated_at":"2026-06-26T04:01:09.747Z","avatar_url":"https://github.com/pbsladek.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tech Study Guide\n\nA searchable personal study guide for infrastructure, networking, databases, Linux, Kubernetes, DNS, identity, and related engineering topics.\n\nThe site is tuned for my own study workflow. It includes full-text search, tags, expandable navigation, light/dark mode, reader mode, live font controls, syntax highlighting, study cards, study paths, scenario labs, and a generated knowledge graph.\n\n## Requirements\n\n- Docker Desktop or a Docker-compatible engine\n- Node.js and npm for Playwright browser tests\n- `make`\n\nRuby and Jekyll run inside Docker, so they do not need to be installed on the host.\n\n## Quick Start\n\nBuild the Jekyll image and generated site:\n\n```bash\nmake build\n```\n\nServe the site locally:\n\n```bash\nmake serve\n```\n\nOpen \u003chttp://127.0.0.1:4030/\u003e.\n\n`make serve` uses Docker Compose through [compose.yaml](compose.yaml). Press `Ctrl-C` in the terminal to stop the server; the Makefile trap runs `docker compose down --remove-orphans` afterward.\n\nIf a container is already running for this app, stop it with:\n\n```bash\nmake stop\n```\n\nUse a different port only when needed:\n\n```bash\nmake serve PORT=4040\n```\n\nThe default port is `4030`.\n\n## Common Commands\n\n```bash\nmake help\nmake docker-build\nmake build\nmake test\nmake e2e\nmake test-all\nmake check\nmake serve\nmake stop\nmake cleanup\nmake clean\n```\n\nCommand summary:\n\n| Command | Purpose |\n| --- | --- |\n| `make docker-build` | Build the local Jekyll Docker image. |\n| `make build` | Generate `_site` with production Jekyll settings. |\n| `make test` | Build the site and run Ruby generated-HTML tests. |\n| `make e2e` | Start the Compose server, run Playwright, then stop the server. |\n| `make test-all` | Run Ruby generated-HTML tests and Playwright browser tests. |\n| `make serve` | Serve the site at `http://127.0.0.1:4030/` by default. |\n| `make stop` | Stop Compose and any running containers with the project prefix. |\n| `make clean` | Remove generated Jekyll output. |\n\n## Browser Tests\n\nInstall Node dependencies and the Chromium browser once:\n\n```bash\nnpm install\nnpm run playwright:install\n```\n\nRun the browser suite:\n\n```bash\nmake e2e\n```\n\n`make e2e` starts the Docker Compose Jekyll server, waits for it to answer, runs Playwright, and stops the server afterward.\n\n`npm run test:e2e` runs Playwright directly and expects a server to already be available at `BASE_URL` or `http://127.0.0.1:4030`.\n\nRun all local checks:\n\n```bash\nmake test-all\n```\n\n## Project Layout\n\n```text\n.\n├── _data/\n│   ├── study_decks.yml\n│   └── study_nav.yml\n├── _includes/\n├── _layouts/\n├── assets/\n├── docs/\n│   ├── ceph/\n│   ├── databases/\n│   ├── dns/\n│   ├── identity/\n│   ├── istio/\n│   ├── kubernetes/\n│   ├── linux/\n│   └── networking/\n├── test/\n│   └── site_test.rb\n├── tests/e2e/\n├── compose.yaml\n├── Dockerfile\n├── Makefile\n└── package.json\n```\n\n## Maintaining Study Notes\n\nCreate Markdown files under `docs/`.\n\nUse front matter like this:\n\n```yaml\n---\ntitle: New Topic\nlayout: page\npermalink: /docs/new-topic/\nsummary: One sentence explaining what this note teaches.\ntags:\n  - example\n  - networking\n---\n```\n\nAdd the page to [_data/study_nav.yml](_data/study_nav.yml) when it should appear in the left navigation.\n\nStudy cards can be added to any page:\n\n```liquid\n{% include study-card.html question=\"What problem does this solve?\" answer=\"A short answer for active recall.\" %}\n```\n\nFor broad topic decks, add cards to [_data/study_decks.yml](_data/study_decks.yml).\n\n## Testing Content Changes\n\nFor substantive content changes, update tests so the important terms cannot disappear silently:\n\n- Add first-command-block expectations in [test/site_test.rb](test/site_test.rb) when the page starts with a command block.\n- Add search-index content assertions for important terms.\n- Add the page to study-card and researched-topic coverage when appropriate.\n- Add Playwright visibility checks in [tests/e2e/site.spec.js](tests/e2e/site.spec.js) for major new pages.\n\nThen run:\n\n```bash\nmake test-all\n```\n\n## GitHub Pages\n\nThis repository includes a GitHub Actions workflow at `.github/workflows/pages.yml`.\n\nWhen publishing my copy:\n\n1. Open the repository settings.\n2. Go to **Pages**.\n3. Set **Build and deployment** to **GitHub Actions**.\n4. Push to `main` or run the workflow manually.\n\n## Agent Notes\n\nSee [AGENTS.md](AGENTS.md) for repo-specific guidance for coding agents and future automation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpbsladek%2Ftech-study-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpbsladek%2Ftech-study-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpbsladek%2Ftech-study-guide/lists"}