Merge pull request #516 from apache/fix-guides-og-url

Fix Open Graph URL for generated guides pages

Author: jamesfredley

buildSrc/src/main/groovy/website/gradle/tasks/GuidesTask.groovy

@@ -205,7 +205,7 @@ abstract class GuidesTask extends GrailsWebsiteTask {
         def guides = GuidesFetcher.fetchGuides(guidesYml)
         def tags = TagUtils.populateTags(guides)
         new File(pages, PAGE_NAME_GUIDES).setText(
-                "title: Guides | Grails Framework\nbody: guides\nJAVASCRIPT: $url/javascripts/search.js\n---\n" +
+                "title: Guides | Grails Framework\nbody: guides\nogurl: $url/guides/index.html\nJAVASCRIPT: $url/javascripts/search.js\n---\n" +
                         GuidesPage.mainContent(guides, tags),
                 'UTF-8'
 
@@ -215,7 +215,7 @@ abstract class GuidesTask extends GrailsWebsiteTask {
         for (def tag : tags) {
             def slug = "${tag.slug.toLowerCase()}.html"
             new File(tagsDir, slug).setText(
-                    "---\ntitle: Guides with tag: $tag.title | Grails Framework\nbody: guides\n---\n" +
+                    "---\ntitle: Guides with tag: $tag.title | Grails Framework\nbody: guides\nogurl: $url/guides/tags/$slug\n---\n" +
                             GuidesPage.mainContent(guides, tags, null, tag),
                     'UTF-8'
 
@@ -225,7 +225,7 @@ abstract class GuidesTask extends GrailsWebsiteTask {
         for (def category : GuidesPage.categories.values()) {
             def slug = "${category.slug.toLowerCase()}.html"
             new File(categoriesDir, slug).setText(
-                    "---\ntitle: Guides at category $category.name | Grails Framework\nbody: guides\n---\n" +
+                    "---\ntitle: Guides at category $category.name | Grails Framework\nbody: guides\nogurl: $url/guides/categories/$slug\n---\n" +
                             GuidesPage.mainContent(guides, tags, category, null),
                     'UTF-8'
             )
@@ -234,7 +234,7 @@ abstract class GuidesTask extends GrailsWebsiteTask {
         for (def version : GuidesPage.availableVersions(guides)) {
             def slug = "${version}.html"
             new File(versionsDir, slug).setText(
-                    "---\ntitle: Guides for Grails $version | Grails Framework\nbody: guides\n---\n" +
+                    "---\ntitle: Guides for Grails $version | Grails Framework\nbody: guides\nogurl: $url/guides/versions/$slug\n---\n" +
                             GuidesPage.mainContent(guides, tags, null, null, version),
                     'UTF-8'
             )

buildSrc/src/main/groovy/website/gradle/tasks/RenderSiteTask.groovy

@@ -233,9 +233,17 @@ abstract class RenderSiteTask extends GrailsWebsiteTask {
             @Nullable File partialsRoot = null
     ) {
         for (def page : listOfPages) {
-            def resolvedMetadata = processMetadata(
-                    siteMeta + page.metadata + [ogurl: siteMeta['url'] + page.path]
-            )
+            // Default the Open Graph URL to <site><page path>, but let a page
+            // override it via its own `ogurl` metadata. Pages parsed from disk
+            // carry a root-relative path (e.g. "/faq.html"), so the default is
+            // correct for them; generated guide pages (index, tags, categories,
+            // versions) carry only a bare leaf filename (e.g. "8.html"), so they
+            // set `ogurl` explicitly to the right /guides/... URL.
+            def pageMetadata = siteMeta + page.metadata
+            if (!pageMetadata.containsKey('ogurl')) {
+                pageMetadata = pageMetadata + [ogurl: siteMeta['url'] + page.path]
+            }
+            def resolvedMetadata = processMetadata(pageMetadata)
             def html = renderHtmlWithTemplateContent(
                     page.content,
                     resolvedMetadata,