You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@grails.apache.org by "jamesfredley (via GitHub)" <gi...@apache.org> on 2026/05/02 12:47:13 UTC

[PR] Polish README + add Authoring a Guide section [grails-static-website]

jamesfredley opened a new pull request, #474:
URL: https://github.com/apache/grails-static-website/pull/474

   ## Summary`n`nFull pass on the README. Two themes:`n`n### Fixes`n`n- Stale ``./gradlew tasks --group=grails`` (no task uses the ``grails`` group anymore - tasks moved to ``grails website``).`n- ``./gradlew buildGuide`` -> ``./gradlew buildGuides`` (the former is a backward-compat alias only).`n- Removed broken ``docs/blogimages.png`` reference (file does not exist).`n- Removed the stale embedded ``tasks --group=grails`` output snippet (goes out of date the moment a new task lands).`n- Typos: ``simpel`` -> ``simple``, ``preffix`` -> ``prefix``, ``live-serve`` -> ``live-server``, plus several broken sentences in the blog metadata section.`n- Replaced the ad-hoc `What to change when a new release is published` blurb with a real `Recording a release` section pointing at the ``recordRelease`` Gradle task (PR #473).`n`n### New major section: Authoring a Guide`n`nFleshes out the guides-related content for would-be guide authors. Covers:`n`n- The three tiers (documentation-only / initial 
 code / initial+complete code).`n- Per-tier step-by-step instructions.`n- Source layout (``manifest.yml``, ``toc.yml``, ``snippets/``) with an example.`n- Two ``conf/guides.yml`` registry shapes (with and without ``sampleRef``).`n- **Requesting a sample-app repository**: explicit path for Tier 2/3 authors via the [community page](https://grails.apache.org/community.html) - dev mailing list and Slack - for the PMC to create the ``grails-guides/<name>`` repository.`n- Local validation checklist (``validateGuides``, ``renderGuide_*``, ``buildAllGuides``, ``verifyAllGuides``).`n`nAlso added a **Repository layout** table near the top so newcomers can orient themselves before diving in.`n`n(refs apache/grails-static-website#354)


-- 
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


Re: [PR] Polish README + add Authoring a Guide section [grails-static-website]

Posted by "jamesfredley (via GitHub)" <gi...@apache.org>.
jamesfredley merged PR #474:
URL: https://github.com/apache/grails-static-website/pull/474


-- 
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