Enable page feedback even without a Google analytics ID (#1727)

google · Nov 14, 2023 · 7187dea · 7187dea
1 parent eaba498
commit 7187dea
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -27,13 +27,19 @@ For the full list of changes, see the [release][0.8.0] notes.
 - SCSS: `@function prepend()` and file `assets/scss/support/_functions.scss`
   have been dropped. Instead use the more general SASS/SCSS list `join()`
   function ([#1385]).
+- **Page feedback**, or [User feedback]: in support of projects configuring
+  analytics outside of Docsy, feedback functionality will be enabled regardless
+  of whether `site.Config.Services.GoogleAnalytics.ID` is set.
+  - TBC
 
 **New**:
 
 **Other changes**:
 
 [#1385]: https://github.com/google/docsy/issues/1385
 [0.8.0]: https://github.com/google/docsy/releases/v0.8.0/#FIXME
+[User feedback]:
+  https://www.docsy.dev/docs/adding-content/feedback/#user-feedback
 
 ## 0.7.2
 

diff --git a/layouts/_default/content.html b/layouts/_default/content.html
@@ -8,10 +8,7 @@ <h1>{{ .Title }}</h1>
 		{{ end -}}
 	</header>
 	{{ .Content }}
-	{{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable) (.Site.GoogleAnalytics)) -}}
-		{{ partial "feedback.html" .Site.Params.ui.feedback }}
-		<br />
-	{{ end -}}
+	{{ partial "feedback.html" . -}}
 	{{ if (.Site.Params.DisqusShortname) -}}
 		<br />
 		{{- partial "disqus-comment.html" . -}}

diff --git a/layouts/docs/list.html b/layouts/docs/list.html
@@ -10,10 +10,7 @@ <h1>{{ .Title }}</h1>
 	</header>
 	{{ .Content }}
   {{ partial "section-index.html" . -}}
-	{{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable) (.Site.GoogleAnalytics)) -}}
-		{{ partial "feedback.html" .Site.Params.ui.feedback -}}
-		<br />
-	{{ end -}}
+	{{ partial "feedback.html" . -}}
 	{{ if (.Site.DisqusShortname) -}}
 		<br />
 		{{- partial "disqus-comment.html" . -}}

diff --git a/layouts/partials/feedback.html b/layouts/partials/feedback.html
@@ -1,3 +1,5 @@
+{{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable)) -}}
+{{ with .Site.Params.ui.feedback -}}
 <style>
   .feedback--answer {
     display: inline-block;
@@ -57,3 +59,6 @@ <h2 class="feedback--title">{{- i18n "feedback_title" -}}</h2>
     sendFeedback(0);
   });
 </script>
+{{ end -}}
+<br />
+{{ end -}}
diff --git a/layouts/swagger/list.html b/layouts/swagger/list.html
@@ -10,10 +10,7 @@ <h1>{{ .Title }}</h1>
 	</header>
 	{{ .Content }}
   {{ partial "section-index.html" . -}}
-	{{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable) (.Site.GoogleAnalytics)) -}}
-		{{ partial "feedback.html" .Site.Params.ui.feedback -}}
-		<br />
-	{{ end -}}
+	{{ partial "feedback.html" . -}}
 	{{ if (.Site.DisqusShortname) -}}
 		<br />
 		{{ partial "disqus-comment.html" . -}}

diff --git a/package.json b/package.json
@@ -23,7 +23,7 @@
     "get:submodule": "set -x && git submodule update --init ${DEPTH:- --depth 1}",
     "postinstall": "npm run _mkdir:hugo-mod && npm run _cp:bs-rfs",
     "serve": "npm run cd:docs serve",
-    "test": "npm run cd:docs test",
+    "test": "npm run cd:docs test && npm run check:links--md",
     "update:pkg:hugo": "npm install --save-exact -D hugo-extended@latest",
     "update:pkg:dep": "npm install --save-exact @fortawesome/fontawesome-free@latest bootstrap@latest"
   },

diff --git a/userguide/content/en/docs/adding-content/feedback.md b/userguide/content/en/docs/adding-content/feedback.md
@@ -132,9 +132,18 @@ other words!
 
 ### Setup
 
-1.  Open `hugo.toml`/`hugo.yaml`/`hugo.json`.
-2.  Ensure that Google Analytics is enabled, as described [above](#setup).
-3.  Set the response text that users see after clicking **Yes** or **No**.
+{{% alert title="Version note" color=warning %}}
+
+As of Docsy version [0.8.0], feedback will be enabled whether
+`site.Config.Services.GoogleAnalytics.ID` is set or not. This supports the use
+case where analytics is configured outside of Docsy.
+
+[0.8.0]: https://github.com/google/docsy/blob/main/CHANGELOG.md/#080
+
+{{% /alert %}}
+
+1.  Open your project's Hugo configuration file.
+2.  Set the response text that users see after clicking **Yes** or **No**.
 
     {{< tabpane >}}
     {{< tab header="Configuration file:" disabled=true />}}
@@ -174,7 +183,7 @@ params:
 {{< /tab >}}
 {{< /tabpane >}}
 
-4.  Save and close `hugo.toml`/`hugo.yaml`/`hugo.json`.
+3.  Save the edits to your configuration file.
 
 ### Access the feedback data
 

diff --git a/userguide/hugo.yaml b/userguide/hugo.yaml
@@ -30,7 +30,7 @@ menu:
 
 services:
   googleAnalytics:
-    id: UA-00000000-0
+    # id: G-XXXXXXXXX # Waiting on https://github.com/google/docsy/issues/1097
 
 languages:
   en: