https://github.com/kanywst/cncf-atlas

A readable map of the cloud native ecosystem: history, architecture, adoption, and code internals for every CNCF project. English and 日本語.
https://github.com/kanywst/cncf-atlas

cloud-native cncf devops documentation gitops i18n knowledge-base kubernetes security vitepress

Last synced: about 20 hours ago
JSON representation

A readable map of the cloud native ecosystem: history, architecture, adoption, and code internals for every CNCF project. English and 日本語.

• Host: GitHub
• URL: https://github.com/kanywst/cncf-atlas
• Owner: kanywst
• License: mit
• Created: 2026-06-21T13:54:49.000Z (23 days ago)
• Default Branch: main
• Last Pushed: 2026-07-07T13:38:45.000Z (7 days ago)
• Last Synced: 2026-07-07T15:17:30.751Z (7 days ago)
• Topics: cloud-native, cncf, devops, documentation, gitops, i18n, knowledge-base, kubernetes, security, vitepress
• Language: JavaScript
• Homepage: https://kanywst.github.io/cncf-atlas/
• Size: 3.21 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 226
• Metadata Files:
  • Readme: README.ja.md
  • License: LICENSE

Awesome Lists containing this project

README

          


[![CI](https://img.shields.io/github/actions/workflow/status/kanywst/cncf-atlas/ci.yml?style=flat-square&label=CI)](https://github.com/kanywst/cncf-atlas/actions/workflows/ci.yml)

[![Security](https://img.shields.io/github/actions/workflow/status/kanywst/cncf-atlas/security.yml?style=flat-square&label=security)](https://github.com/kanywst/cncf-atlas/actions/workflows/security.yml)

[![Pages](https://img.shields.io/github/actions/workflow/status/kanywst/cncf-atlas/deploy.yml?style=flat-square&label=pages)](https://github.com/kanywst/cncf-atlas/actions/workflows/deploy.yml)

[![License](https://img.shields.io/badge/license-MIT-4d9fff?style=flat-square)](./LICENSE)

[![Stars](https://img.shields.io/github/stars/kanywst/cncf-atlas?style=flat-square&color=4d9fff)](https://github.com/kanywst/cncf-atlas)

[![Live site](https://img.shields.io/badge/site-live-4d9fff?style=flat-square)](https://kanywst.github.io/cncf-atlas/)

[English](./README.md) · **日本語**

## なぜ作るか

CNCF landscape は数百のプロジェクトをグリッド上のロゴとして並べる。プロジェクトが存在することは分かるが、それが何で、どう動き、自分のスタックに合うかは分からない。CNCF Atlas はそこを埋める。各プロジェクトに、実際のリポジトリを読んで書いたディープダイブを用意し、毎回同じ構成にする。だから上から下まで読めば理解して帰れる。

## できること

- カテゴリで辿れるドキュメントサイト。各プロジェクトに CNCF の成熟度タグが付く。

- プロジェクトごとに同じ順序の 6 セクション。どこを見ればいいか分かる。

- 既定は英語、完全な日本語版あり。どのページでも言語を切り替えられる。

- 再現可能な 2 段階の執筆プロセス: ピン留めしたコミットのソースを読み、統一構成でバイリンガルのディープダイブを書く。

## ディープダイブが扱うこと

| セクション | 答えること |

| --- | --- |

| Overview | 何で、いつ使い、主要な事実は何か。 |

| History | どこから来て、どうここまで来たか。 |

| Architecture | コンポーネントと、リクエストがどう流れるか。 |

| Adoption & Ecosystem | 誰が運用し（出典付き）、周囲に何があり、代替は何か。 |

| Internals | 重要なコードパス、ソースからの引用。 |

| Getting Started | インストールして最初の構成を動かす。 |

## リポジトリ構成

```text

docs/                      VitePress サイト

  .vitepress/

    config.ts              i18n（英語ルート + 日本語）、サイドバーは tools.ts から生成

    tools.ts               カタログレジストリ、単一ソース

    theme/                 カスタムテーマ: カタログカード、ブランド CSS

  index.md                 英語ホーム

  tools//            英語ディープダイブ（6 ページ）

  ja/                      日本語ミラー

templates/tool-doc/        writer がコピーする英日のセクション雛形

research//           プロジェクトごとの作業領域（メモ・出典; src/ は gitignore）

scripts/check-tools.mjs    CI チェック: 各カタログ項目に全ページが揃っているか

```

## ローカルで動かす

```bash

npm install

npm run docs:dev      # http://localhost:5173

npm run docs:build    # docs/.vitepress/dist へ本番ビルド

npm test              # カタログレジストリとファイルの整合チェック

```

## プロジェクトを追加する

各ディープダイブは 2 段階で作る:

1. **Recon**: upstream を clone してコミットをピン留めし、アーキテクチャと重要パスを地図化、出典付きの歴史・採用素材を `research//` に集める。

2. **Write**: その調査をバイリンガル 6 セクションのディープダイブに起こし、`docs/.vitepress/tools.ts` にプロジェクトを登録する。

`tools.ts` に 1 エントリ足すと、サイドバーとホームのカタログが同時に更新される。

## ライセンス

[MIT](./LICENSE)。