chainguard-dev/edu

Chainguard 아카데미

Chainguard Academy는 Chainguard 제품에 대한 문서 사이트입니다. Chainguard와 함께 성공할 수 있도록 합니다. edu.chainguard.dev에 방문

content] 디렉토리에서 Markdown의 교육 리소스 파일을 찾을 수 있습니다.

개발

이 사이트는 Doks Hugo 테마를 기반으로합니다.

이 프로젝트를 개발하려는 경우, 이 재포를 복제하고 npm와 의존성을 설치합니다. npm ci] npm install]에 npm ci](클린 설치)를 선호합니다. package-lock.json]에서 정확한 의존성 트리를 설치하므로 로컬 버전은 빌드 자동화 및 생산이 어떻게 일치합니다.

이 사이트의 로컬 버전을 실행하려면 개발 서버를 시작합니다.

서버가 실행 중, 웹 브라우저에서 http://localhost:1313을 엽니다. 서버를 중지하려면 터미널에서 Ctrl+C를 누릅니다.

테스트

Chainguard Academy에 게시된 모든 문서는 정확성을 위해 신중하게 검토됩니다. GUI 절차, API 명령 및 CLI 코드 스니펫을 초안에서 실행하고 테스트합니다. 저자와 검토자 모두에 의해 - 작성된대로 정확히 작동을 확인합니다. 이 도움말은 독자가 따라 따를 수 있고 동일한 결과를 얻을 수 있습니다.

Chainguard Academy

Chainguard Academy is the documentation site for Chainguard products. It exists to help you succeed with Chainguard. Visit it at 🔗 edu.chainguard.dev

You can find the educational resource files in Markdown under the content directory.

Development

This site is based on the Doks Hugo theme.

If you would like to develop this project, clone this repo and install dependencies with npm. We prefer npm ci (clean install) over npm install: it installs the exact dependency tree from package-lock.json, so your local versions match what our build automation and production use.

npm ci

To run a local version of this site, start the development server:

npm run start

While the server is running, open http://localhost:1313/docs/ in your web browser. To stop the server, press Ctrl+C in the terminal.

Testing

Any documentation published to Chainguard Academy is reviewed carefully for accuracy. GUI procedures, API commands, and CLI code snippets in a draft are run and tested thoroughly — by both the author and the reviewer — to confirm they work exactly as written. This helps ensure that readers can follow along and get the same results.

We also test drafts by previewing rendered content before it’s published. Draft content passes through several checks between your editor and the live site:

• Local preview — Run npm ci once, then npm run start to serve the site at http://localhost:1313/docs/ with live reload. Use this to confirm pages render correctly, formatting holds up, and internal links resolve. When a doc includes commands or examples, run them to confirm they still work.
• Pre-commit checks — A required pre-commit check validates tags, lints, and scans changed files; a git hook stamps content dates; spell-check runs locally. See Pre-commit below for setup.
• Deploy previews — Every pull request builds a Vercel deploy preview with its own URL. Reviewers open this link to see your changes rendered as they’ll appear in production. For a pull request from a fork, a Docs team member must authorize each push before its preview builds.

When you open a pull request, describe how you tested the change so reviewers know what to verify. Recent PRs often list the steps taken, such as previewing pages in the Hugo dev server, confirming links resolve, and running any commands the doc relies on.

📑 Contributing