OSSがDocsに使ってるツール一覧

とりあえず、よく見るところだけ書いた(適宜更新予定)

Hugo

• https://kubernetes.io/
• https://istio.io/
• https://etcd.io/
• https://prometheus-operator.dev/
• https://www.kubeflow.org/
• https://skaffold.dev/
• https://github.com/kiali/kiali.io
• https://thanos.io/
• https://keda.sh/
• https://vitess.io/
• https://tekton.dev/

Material for MkDocs

• https://kserve.github.io/
• https://knative.dev/docs/
• https://argo-cd.readthedocs.io/
• https://riverml.xyz/latest/
• https://doc.traefik.io/traefik/
• https://external-secrets.io/
• https://www.conftest.dev/

Gitbook

• https://quii.gitbook.io/learn-go-with-tests/
• https://docs.feast.dev/

mdbook

• https://book.kubebuilder.io/
• https://metacontroller.github.io/metacontroller/

言葉

• Static Site Generator (SSG)
  • データやテンプレートから静的HTMLウェブサイトを生成するツール。
  • 毎回同じものを返すものに使われ、prebuildしたものを使うことで、ロードが早い。
• JAMstack
  • JAMstack (JAM: "JavaScript, APIs, Markup")は、効率的に軽くて、早いウェブアプリケーションを作成する方法。SSGもこれに入る。
• Content Management Systems (CMS)
  • SSGに対応するCMSは、サーバー側で、リクエストに対応するデータとテンプレートからHTMLを生成するタイプ。毎回のリクエストによって表示する内容を変える必要があるウェブサービスはこちらを用いる。毎回サーバー側での処理（例. データベースにアクセス）が必要なので、毎回生成してフロントへ返して上げる必要あり。

比較&感想

1. シンプルにやるならmkdocsが楽そう
2. mdBookのPreprocessorは便利そう (例. suite_test.go -> Writing controller tests)

参考

• https://www.cloudflare.com/learning/performance/static-site-generator/
• https://jamstack.org/
• https://gohugo.io/
• https://rust-lang.github.io/mdBook/
• https://www.mkdocs.org/
• https://squidfunk.github.io/mkdocs-material/
• https://www.gitbook.com/