refactor(docs): separate Pages site source (#6176)

* refactor(docs): separate Pages site source

* fix(docs): preserve published guide pages

* fix(ci): run asset ownership tests for site changes

* fix(docs): track future website media

* fix(ci): let Pages deployments finish

* build(deps): update Pages checkout action

* fix(ci): follow moved setup guide

* fix(docs): repair published setup guide

* fix(docs): retarget preview encoder
This commit is contained in:
RaresKeY
2026-08-27 10:20:36 +02:00
committed by GitHub
parent 7026cf40b5
commit c9dd68d890
34 changed files with 277 additions and 43 deletions
+137 -19
View File
@@ -1,30 +1,39 @@
"""Regression guard for issue #1335 — PR review screenshots were committed into
docs/ (docs/a11y/*.png from #738, docs/gallery-314-*.png from #644) where they
served no purpose: nothing in the repo referenced them, so they just showed up
as "random images" in the doc folder.
"""Repository asset ownership guards for issues #1335 and #6175.
This test fails if any image under docs/ is orphaned — present in the tree but
referenced by no tracked text file. The intended doc assets (the README hero
image and the feature preview clips) are referenced, so they pass; a stray
screenshot dropped in by a future PR would not.
Public Markdown and landing-page media belong in website/, while shared
README/packaging imagery belongs in assets/branding/. Images in either managed
root must be referenced by tracked text, and every tracked website video must
be referenced by the site's entry point.
"""
import re
import subprocess
from pathlib import Path
from urllib.parse import urlsplit
import pytest
REPO = Path(__file__).resolve().parent.parent
IMAGE_EXTS = {".png", ".jpg", ".jpeg", ".gif", ".webp", ".bmp"}
VIDEO_EXTS = {".webm", ".mp4", ".mov", ".m4v"}
PUBLIC_GUIDES = {
"agent-migration.md",
"attachments.md",
"backup-restore.md",
"email-outlook.md",
"pr-blocker-audit.md",
"security-ci.md",
"setup.md",
}
# Files a referenced image name could legitimately appear in.
TEXT_EXTS = {".md", ".html", ".htm", ".js", ".ts", ".css", ".py", ".sh",
".json", ".yml", ".yaml", ".txt"}
def _tracked(paths_under):
"""Git-tracked files under a path, or None if git isn't available."""
def _tracked(*paths_under):
"""Git-tracked files under paths, or None if git isn't available."""
try:
out = subprocess.run(
["git", "ls-files", paths_under],
["git", "ls-files", "--", *paths_under],
cwd=REPO, capture_output=True, text=True, timeout=30,
)
except (OSError, subprocess.SubprocessError):
@@ -34,12 +43,14 @@ def _tracked(paths_under):
return [REPO / line for line in out.stdout.splitlines() if line.strip()]
def test_no_orphan_images_in_docs():
docs_images = _tracked("docs")
if docs_images is None:
def test_no_orphan_documentation_or_branding_images():
managed_files = _tracked("website", "assets/branding")
if managed_files is None:
pytest.skip("not a git checkout")
docs_images = [p for p in docs_images if p.suffix.lower() in IMAGE_EXTS]
assert docs_images, "expected docs/ to still contain referenced doc assets"
managed_images = [p for p in managed_files if p.suffix.lower() in IMAGE_EXTS]
assert any("assets/branding" in p.as_posix() for p in managed_images), (
"expected assets/branding/ to contain the shared project imagery"
)
# All tracked text we might reference an image from.
all_tracked = _tracked(".") or []
@@ -55,10 +66,117 @@ def test_no_orphan_images_in_docs():
orphans = [
str(img.relative_to(REPO))
for img in docs_images
for img in managed_images
if img.name not in blob
]
assert not orphans, (
"unreferenced image(s) committed under docs/ — likely PR screenshots "
f"added by accident (see #1335): {orphans}"
"unreferenced image(s) committed under website/ or assets/branding/ "
f"(see #1335 and #6175): {orphans}"
)
def test_pages_site_owns_its_entrypoint_and_media():
docs_files = _tracked("docs")
website_files = _tracked("website")
if docs_files is None or website_files is None:
pytest.skip("not a git checkout")
assert REPO / "website/index.html" in website_files
assert REPO / "docs/index.html" not in docs_files
assert not [p for p in docs_files if p.suffix.lower() in VIDEO_EXTS | {".md"}]
website_paths = {p.relative_to(REPO / "website").as_posix() for p in website_files}
assert PUBLIC_GUIDES <= website_paths
for guide in PUBLIC_GUIDES:
text = (REPO / "website" / guide).read_text(encoding="utf-8")
assert text.startswith("---\nlayout: default\n---\n"), guide
website_videos = [p for p in website_files if p.suffix.lower() in VIDEO_EXTS]
assert website_videos, "expected website/ to contain the landing-page videos"
entrypoint = (REPO / "website/index.html").read_text(encoding="utf-8")
unreferenced = [
str(video.relative_to(REPO))
for video in website_videos
if video.name not in entrypoint
]
assert not unreferenced, f"unreferenced website video(s): {unreferenced}"
workflow = (REPO / ".github/workflows/deploy-pages.yml").read_text(encoding="utf-8")
assert "actions/jekyll-build-pages@" in workflow
assert "source: website" in workflow
assert "destination: _site" in workflow
assert "path: _site" in workflow
assert "cancel-in-progress: false" in workflow
def test_pages_guides_keep_relative_links_inside_site():
site_root = (REPO / "website").resolve()
for guide in sorted(PUBLIC_GUIDES):
guide_path = REPO / "website" / guide
text = guide_path.read_text(encoding="utf-8")
for target in re.findall(r"\]\(([^)]+)\)", text):
parsed = urlsplit(target)
if parsed.scheme or parsed.netloc or not parsed.path:
continue
resolved = (guide_path.parent / parsed.path).resolve()
assert resolved.is_relative_to(site_root), (
f"{guide} links outside the Pages source: {target}"
)
assert resolved.exists(), f"{guide} has a missing local link: {target}"
def test_setup_preserves_docker_go_template_literal():
setup = (REPO / "website/setup.md").read_text(encoding="utf-8")
guarded_command = """<!-- {% raw %} -->
```bash
docker info --format '{{.DockerRootDir}}'
```
<!-- {% endraw %} -->"""
assert guarded_command in setup
def test_preview_encoder_targets_pages_source():
encoder = (REPO / "scripts/encode_previews.sh").read_text(encoding="utf-8")
assert "landing page: website/<name>.webm" in encoder
assert 'OUT_DIR="$(cd "$(dirname "$0")/../website" && pwd)"' in encoder
def test_ci_runs_asset_ownership_guards_for_managed_roots():
workflow = (REPO / ".github/workflows/ci.yml").read_text(encoding="utf-8")
match = re.search(r"grep -Ev '([^']+)'", workflow)
assert match, "expected the docs-only path classifier in CI"
docs_only = re.compile(match.group(1))
assert docs_only.match("README.md")
assert docs_only.match("docs/example.md")
assert not docs_only.match("website/setup.md")
assert not docs_only.match("website/new-preview.webm")
assert not docs_only.match("assets/branding/new-logo.png")
@pytest.mark.parametrize(
"path",
[
"website/favicon.png",
"website/media/social-card.jpg",
"website/guides/reference.pdf",
"assets/branding/new-logo.gif",
"assets/branding/print/logo.tiff",
],
)
def test_managed_site_media_is_not_ignored(path):
result = subprocess.run(
["git", "check-ignore", "--no-index", "--quiet", path],
cwd=REPO,
capture_output=True,
text=True,
timeout=30,
)
if result.returncode == 128:
pytest.skip("not a git checkout")
assert result.returncode == 1, f"{path} is unexpectedly ignored"
+1 -1
View File
@@ -30,7 +30,7 @@ def test_kokoro_feature_markers_match_supported_python_range(python_version, sel
def test_setup_documents_container_constraint_and_install_command():
setup = (ROOT / "docs" / "setup.md").read_text(encoding="utf-8")
setup = (ROOT / "website" / "setup.md").read_text(encoding="utf-8")
assert "pip install -r requirements-optional.txt" in setup
assert "default Docker image currently uses Python 3.14" in setup
+2 -2
View File
@@ -123,10 +123,10 @@ def test_docker_compose_binds_web_ui_to_loopback_by_default():
def test_readme_native_quickstart_uses_loopback():
# The README refresh (#4306) moved the native quickstart into docs/setup.md,
# The Pages source split (#6175) moved the native quickstart into website/setup.md,
# so accept the loopback guidance from either the README or the setup guide.
docs = Path("README.md").read_text(encoding="utf-8")
docs += "\n" + Path("docs/setup.md").read_text(encoding="utf-8")
docs += "\n" + Path("website/setup.md").read_text(encoding="utf-8")
assert "python -m uvicorn app:app --host 127.0.0.1 --port 7000" in docs
assert "0.0.0.0` only when you intentionally want" in docs
+1 -1
View File
@@ -29,7 +29,7 @@ def test_create_default_admin_normalizes_env_username(tmp_path, monkeypatch):
def test_main_loads_admin_password_from_env_file(tmp_path, monkeypatch):
"""Regression: setup.py must honor an admin password pre-seeded in .env on
native installs, even when the var is not exported into the shell
(docs/setup.md documents this). Previously setup.py never called
(website/setup.md documents this). Previously setup.py never called
load_dotenv(), so os.getenv() saw nothing and a random password was
generated instead."""
import bcrypt