Re: [PR] Add conf/guides.yml + tighten publish.yml comment (refs #354) [grails-static-website]

["jamesfredley (via GitHub)" <gi...@apache.org>]

jamesfredley commented on code in PR #447:
URL: https://github.com/apache/grails-static-website/pull/447#discussion_r3171284334


##########
conf/guides.yml:
##########
@@ -0,0 +1,46 @@
+# Single source of truth for guide metadata.
+#
+# Replaces the runtime `new URL("https://raw.githubusercontent.com/.../gh-pages/guides.json").text`
+# fetch in `GuidesFetcher` with a local YAML file. The migration from
+# remote-fetch to local-yaml lands incrementally:
+#
+#   1. THIS FILE (initial form): one fixture entry to bootstrap the
+#      schema and let the validator be exercised against real content.
+#   2. Auto-import follow-up: a Gradle task imports all entries from
+#      the captured `gh-pages/guides.json` snapshot, applying known
+#      typo / branch-name fixes recorded in the migration plan.
+#   3. GuidesFetcher swap: replace the network fetch with SnakeYAML
+#      parsing of this file. genGuides reads from here.
+#
+# Each step is its own PR. This file grows as guides land in the
+# `guides/<name>/v{N}/` tree.
+#
+# Schema reference: `.sisyphus/plans/issue-354-publishing-migration-v7.md`
+# Appendix A.1.

Review Comment:
   You are right -- I caught this in parallel and force-pushed the fix in commit `5c984dedd6` (visible in the current PR head). Both the `.sisyphus/plans/...` reference here and a similar one in `.github/workflows/publish.yml` were dropped in that push.
   
   The reasoning matches yours exactly: those paths point at a local-only working directory that does not exist in this repo, so they are dead refs from a reader's perspective. Public refs (the `#354` issue, GitHub URLs, the legacy/new domain names) stay; the `.sisyphus/...` paths leak the local-only docs.
   
   Resolving.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@grails.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org