diff --git a/CHANGELOG.md b/CHANGELOG.md index 179b6c938a..0707286fa7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,11 +24,18 @@ For the full list of changes, see the [release][0.8.0] notes. **Breaking changes**: +- **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**: [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/package.json b/package.json index 9118b86154..958c8f19f6 100644 --- 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 index c6c401c9b3..578e21eb62 100644 --- 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 index 39e80256e3..0d9175f62e 100644 --- a/userguide/hugo.yaml +++ b/userguide/hugo.yaml @@ -30,7 +30,7 @@ menu: services: googleAnalytics: - # id: G-XXXXXXXXX + # id: G-XXXXXXXXX # Waiting on https://github.com/google/docsy/issues/1097 languages: en: