Initial docs infra

Author: rramkumar1

.gitignore

@@ -0,0 +1,26 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+bin/*
+Dockerfile.cross
+# Test binary, built with `go test -c`
+*.test
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+# Go workspace file
+go.work
+go.work.sum
+# Kubernetes Generated files - skip generated files, except for vendored files
+!vendor/**/zz_generated.*
+# editor and IDE paraphernalia
+.idea
+.vscode
+*.swp
+*.swo
+*~
+
+# generated docs
+site

Makefile

@@ -0,0 +1,17 @@
+
+##@Docs
+
+.PHONY: build-docs
+build-docs:
+		docker build --pull -t kube-agentic-net/mkdocs hack/mkdocs/image
+			docker run --rm -v ${PWD}:/docs kube-agentic-net/mkdocs build
+
+.PHONY: build-docs-netlify
+build-docs-netlify:
+		pip install -r hack/mkdocs/image/requirements.txt
+			mkdocs build
+
+.PHONY: live-docs
+live-docs:
+		docker build -t kube-agentic-net/mkdocs hack/mkdocs/image
+			docker run --rm -it -p 3000:3000 -v ${PWD}:/docs kube-agentic-net/mkdocs

hack/mkdocs/image/Dockerfile

@@ -0,0 +1,26 @@
+# Copyright 2019 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM python:3.13-alpine
+
+COPY requirements.txt /requirements.txt
+RUN pip install -r /requirements.txt
+
+WORKDIR /docs
+
+EXPOSE 3000
+
+COPY entrypoint.sh /
+
+ENTRYPOINT ["/entrypoint.sh"]

hack/mkdocs/image/entrypoint.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+
+# Copyright 2019 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -o errexit
+set -o pipefail
+
+CMD=$1
+
+if [ "$CMD" == "build" ];
+then
+  mkdocs build
+  exit 0;
+fi
+
+mkdocs serve --dev-addr=0.0.0.0:3000 --livereload#!/bin/bash

hack/mkdocs/image/requirements.txt

@@ -0,0 +1,25 @@
+# required for mkdocs-core
+jinja2~=3.0
+# mkdocs 2.4.1 requires Markdown < 3.4.0
+# https://github.com/kubernetes-sigs/gateway-api/pull/1671#issuecomment-1400586465
+markdown~=3.7
+mkdocs~=1.6
+mkdocs-material-extensions~=1.3
+pygments~=2.16
+pymdown-extensions~=10.2
+
+# Requirements for plugins
+babel~=2.10
+colorama~=0.4
+paginate~=0.5
+regex>=2022.4
+requests~=2.26
+
+# mkdocs + mkdocs plugins
+mkdocs==1.6.1
+mkdocs-awesome-pages-plugin==2.9.3
+mkdocs-macros-plugin==1.2.0
+mkdocs-material==9.5.36
+mkdocs-material-extensions==1.3.1
+mkdocs-redirects==1.2.1
+mkdocs-mermaid2-plugin==1.1.1

mkdocs.yml

@@ -0,0 +1,72 @@
+site_name: Kubernetes Gateway API Inference Extension
+repo_url: https://github.com/kubernetes-sigs/gateway-api-inference-extension
+repo_name: kubernetes-sigs/gateway-api-inference-extension
+site_dir: site
+docs_dir: site-src
+extra_css:
+  - stylesheets/extra.css
+theme:
+  name: material
+  icon:
+    repo: fontawesome/brands/git-alt
+  logo: images/logo/logo-text-large-horizontal-white.png
+  favicon: images/k8s-favicon.png
+  features:
+    - search.highlight
+    - navigation.tabs
+    - navigation.top
+    - navigation.expand
+  palette:
+    primary: custom
+  custom_dir: site-src/overrides
+edit_uri: edit/main/site-src/
+plugins:
+  - search
+  - awesome-pages
+  - macros:
+      include_dir: examples
+      j2_line_comment_prefix: "#$"
+  - mermaid2
+markdown_extensions:
+  - admonition
+  - meta
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.details
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.snippets
+  - toc:
+      permalink: true
+  - tables
+nav:
+  - Overview:
+    - Introduction: index.md
+    - Concepts:
+        API Overview: concepts/api-overview.md
+        Conformance: concepts/conformance.md
+        Roles and Personas: concepts/roles-and-personas.md
+        Use Cases: concepts/use-cases.md
+    - Implementations: implementations.md
+    - FAQ: faq.md
+    - Glossary: concepts/glossary.md
+  - Guides:
+    - User Guides:
+      - Getting started: guides/index.md
+    - Implementer's Guide: guides/implementers.md
+  - Reference:
+    - API Types:
+      - InferencePool: api-types/inferencepool.md
+      - InferenceModel: api-types/inferencemodel.md
+    - API specification: reference/spec.md
+  - Enhancements:
+    - Overview: gieps/overview.md
+  - Contributing:
+    - How to Get Involved: contributing/index.md
+    - Developer Guide: contributing/devguide.md

netlify.toml

@@ -0,0 +1,6 @@
+# netlify configuration
+[build]
+publish = "site"
+command = "make build-docs-netlify"
+# available here https://github.com/netlify/build-image/blob/focal/included_software.md#languages
+environment = { PYTHON_VERSION = "3.8" }