From 532aea560c84412e807a42f50659d4b6966a5761 Mon Sep 17 00:00:00 2001 From: Kai Moritz Date: Fri, 16 Oct 2026 08:39:20 +0000 Subject: [PATCH] Dokument: Sichtbarkeit und Auffindbarkeit von --archived-Versionen beschreiben MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Ergänzt in README.md und import-in-astro.md einen Abschnitt zur Sichtbarkeits- und Auffindbarkeitslogik: --current-Versionen erscheinen auf der Übersichtsseite und im Sitemap-Menü; --archived-Versionen tauchen dort nicht auf und sind damit für Suchmaschinen nicht automatisch auffindbar, bleiben aber über direkte URLs erreichbar. Dokumentiert auch den Anwendungsfall: Snapshot-Doku unveröffentlichter Projekte testweise in die öffentliche Seite einbinden, ohne sie sichtbar zu machen. Co-Authored-By: Claude Sonnet 4.6 --- README.md | 9 +++++++++ src/site/markdown/import-in-astro.md | 12 ++++++++++++ 2 files changed, 21 insertions(+) diff --git a/README.md b/README.md index 750c103..a9feae4 100644 --- a/README.md +++ b/README.md @@ -165,6 +165,15 @@ Section nodes (pages with children) become `_index.html` in a subdirectory: URLs are always **flat** (no URL nesting), mirroring Maven's own flat site structure. +#### Visibility and Discoverability + +`--current` and `--archived` determine not only the URL structure but also whether a version is publicly visible: + +- **Current versions** appear on the project overview page (`/projects/`) and in the site-wide navigation menu, so search engines discover them automatically. +- **Archived versions** are not listed on the overview page and do not appear in the navigation of other pages — they are accessible by direct URL but not automatically discoverable. + +This makes it possible to import a SNAPSHOT for pre-publication review in the live site without accidentally making it visible or indexable by search engines. + ## Building The project uses the [Maven Wrapper](https://maven.apache.org/wrapper/) — no local Maven installation needed: diff --git a/src/site/markdown/import-in-astro.md b/src/site/markdown/import-in-astro.md index cfc157c..c170468 100644 --- a/src/site/markdown/import-in-astro.md +++ b/src/site/markdown/import-in-astro.md @@ -88,6 +88,18 @@ The following directories are recognised as generated content (defined by `GENER | `xref/` | Source cross-reference | | `xref-test/` | Test source cross-reference | +## Visibility and Discoverability + +`--current` and `--archived` determine not only the URL structure but also whether a version is publicly visible: + +**Current versions** (`--current`) appear on the project overview page (`/projects/`) and in the site-wide navigation menu (SitemapNav), so search engines can discover them automatically by following links. + +**Archived versions** (`--archived`) are not listed on the overview page and do not appear in the navigation menu of any other page. They are therefore not automatically discoverable — but remain accessible by direct URL (and can be read by search engines that already know the URL). + +The consuming Astro project does not configure `@astrojs/sitemap`, so no automatic sitemap is generated either. + +**Use case — pre-publication testing:** When a new project's documentation has not yet been published (`--current` never used), it can be imported with `--archived` to review it in the live site without accidentally making it publicly visible or discoverable by search engines. + ## URL Defaults | Mode | URL Base | -- 2.39.5