Skip to content

Commit

Permalink
CL + doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin committed Nov 12, 2023
1 parent 01fc167 commit acd70d5
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 6 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
17 changes: 13 additions & 4 deletions userguide/content/en/docs/adding-content/feedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 />}}
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion userguide/hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ menu:

services:
googleAnalytics:
# id: G-XXXXXXXXX
# id: G-XXXXXXXXX # Waiting on https://github.com/google/docsy/issues/1097

languages:
en:
Expand Down

0 comments on commit acd70d5

Please sign in to comment.