chainguard-dev/edu

チェーンガードアカデミー

Chainguard AcademyはChainguard製品のドキュメントサイトです。 チェーンガードで成功するのを助ける存在です。 訪問する wpmaster edu.chainguard.dev

[content]ディレクトリの下にあるMarkdownの教育リソースファイルを見つけることができます。

開発

このサイトはDoks Hugoテーマに基づいています。

このプロジェクトを開発したい場合は、このリポジトリをクローンし、[npm]で依存関係をインストールします。 [npm ci] (クリーンインストール) をnpm install] に優先します。[package-lock.json]]] から正確な依存ツリーをインストールします。そのため、ローカルバージョンは、ビルドの自動化と生産用途にマッチします。

このサイトのローカルバージョンを実行するには、開発サーバーを開始します。

サーバが稼働している間、Webブラウザで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