chainguard-dev/edu

Академия Хранителей

Chainguard Academy является сайтом документации для продуктов Chainguard. Это поможет вам добиться успеха с Chainguard. Посмотреть на edu.chainguard.dev

Вы можете найти файлы образовательных ресурсов в Markdown в каталоге content.

##Развитие

Этот сайт основан на теме Doks Hugo.

Если вы хотите разработать этот проект, клонируйте этот репо и установите зависимости с npm. Мы предпочитаем npm ci (чистая установка) npm install: он устанавливает точное дерево зависимостей от package-lock.json, поэтому ваши локальные версии соответствуют тому, что использует наша автоматизация сборки и производство.

Чтобы запустить локальную версию этого сайта, запустите сервер разработки:

Пока сервер работает, откройте http://localhost:1313 в своем веб-браузере. Чтобы остановить сервер, нажмите Ctrl+C в терминале.

Тестирование

Любая документация, опубликованная в Chainguard Academy, тщательно проверяется на точность. Процедуры графического интерфейса, команды 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