sanjana2505006 commented on PR #534:
URL:
https://github.com/apache/grails-static-website/pull/534#issuecomment-5270371292
@jamesfredley Thank you for asking me to review this, I've learned a lot
from your feedback on my guides, so I tried to be as careful here.
Overall this looks solid. The sample design is clear (JobRequest over Groovy
closures, AFTER_COMMIT enqueue, dedicated dataSource_jobrunr, OSS vs Pro called
out), and the vendored snippets match grails-guides/grails-jobrunr@grails8 for
the files I diffed. Branch-aware ZIP download is a nice fix too.
A few notes:
1. TOC label vs content — under gettingStarted, `requirements` is titled
"What You Will Build and Need", but `requirements.adoc` is only prerequisites.
"What you will build" lives in `gettingStarted.adoc`. Other guides use "What
you will need" here; maybe align?
2. Shared guide chrome — `guide.css` / `guideItem.html` / `layout.html`
change all guides (viewport, TOC focus, chapter nav, print wrapping, `#main
h1/h2` → `#d97706`). The a11y/responsive bits look good; just confirming the
amber headings are intentional site-wide.
3. Snippet coverage, companion has `JobExamplesControllerSpec` /
`JobExamplesServiceSpec` that aren't vendored. Fine if intentional (guide
doesn't include them); mentioning in case you want parity.
4. Small runbook nits (optional):
- `runningTheApp` curl examples could add `-H "Content-Type:
application/x-www-form-urlencoded"` for the POST (works without it, but clearer
for copy-paste).
- xrefs to `operations.adoc#operations` — please confirm `#operations`
resolves in the rendered HTML (no explicit `[[operations]]` in the adoc).
Companion looks good:
[grails-jobrunr](https://github.com/grails-guides/grails-jobrunr)
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
