feat(portal): EqualWeb integration#5673
Conversation
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
cloudjumpercat
added
do not merge
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Adds EqualWeb as a Dev Portal integration in the docs site, fulfilling the Dev Portal integrations discovery + setup guidance requested in #4802.
Changes:
- Adds an EqualWeb integration card to the Dev Portal landing page integrations section.
- Adds a new Integrations section to the Dev Portal docs index and includes the EqualWeb page.
- Introduces a new how-to describing how to enable and configure the EqualWeb widget, plus a new
accessibilitytag.
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| app/_landing_pages/dev-portal.yaml | Adds an EqualWeb integration tile under “Dev Portal integrations”. |
| app/_indices/dev-portal.yaml | Adds an “Integrations” section and links EqualWeb alongside existing integrations. |
| app/_how-tos/dev-portal/equalweb.md | New how-to guiding users through retrieving the site key, enabling the integration, and validating it. |
| app/_data/schemas/frontmatter/tags.json | Adds the accessibility tag so the new how-to frontmatter validates. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
| ```json | ||
| "Position": "left", | ||
| "Menulang": "EN", | ||
| "draggable": true, | ||
| "btnStyle": { | ||
| "vPosition": [ | ||
| "80%", | ||
| "80%" | ||
| ], | ||
| "margin": [ | ||
| "0", | ||
| "0" | ||
| ], | ||
| "scale": [ | ||
| "0.5", | ||
| "0.5" | ||
| ], | ||
| "color": { | ||
| "main": "#1c4bb6", | ||
| "second": "#ffffff" | ||
| }, | ||
| "icon": { | ||
| "outline": false, | ||
| "outlineColor": "#ffffff", | ||
| "type": 1 , | ||
| "shape": "circle" | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Check me here, but I think you want this to be a valid JSON object?
| ```json | |
| "Position": "left", | |
| "Menulang": "EN", | |
| "draggable": true, | |
| "btnStyle": { | |
| "vPosition": [ | |
| "80%", | |
| "80%" | |
| ], | |
| "margin": [ | |
| "0", | |
| "0" | |
| ], | |
| "scale": [ | |
| "0.5", | |
| "0.5" | |
| ], | |
| "color": { | |
| "main": "#1c4bb6", | |
| "second": "#ffffff" | |
| }, | |
| "icon": { | |
| "outline": false, | |
| "outlineColor": "#ffffff", | |
| "type": 1 , | |
| "shape": "circle" | |
| } | |
| } | |
| ``` | |
| ```json | |
| { | |
| "Position": "left", | |
| "Menulang": "EN", | |
| "draggable": true, | |
| "btnStyle": { | |
| "vPosition": [ | |
| "80%", | |
| "80%" | |
| ], | |
| "margin": [ | |
| "0", | |
| "0" | |
| ], | |
| "scale": [ | |
| "0.5", | |
| "0.5" | |
| ], | |
| "color": { | |
| "main": "#1c4bb6", | |
| "second": "#ffffff" | |
| }, | |
| "icon": { | |
| "outline": false, | |
| "outlineColor": "#ffffff", | |
| "type": 1 , | |
| "shape": "circle" | |
| } | |
| } | |
| } |
There was a problem hiding this comment.
These docs are written into two parts: the EqualWeb side, and the Konnect side. I think the idea here is that what you're copying isn't JSON, but what you're submitting will be. Agree this could be made a little clearer though.
There was a problem hiding this comment.
@adamdehaven Nathanael is correct, I wanted to show what users are seeing in EqualWeb here, so it isn't valid json.
There was a problem hiding this comment.
Noted. FYI the original code block is still mis-indented
| ```json | |
| "Position": "left", | |
| "Menulang": "EN", | |
| "draggable": true, | |
| "btnStyle": { | |
| "vPosition": [ | |
| "80%", | |
| "80%" | |
| ], | |
| "margin": [ | |
| "0", | |
| "0" | |
| ], | |
| "scale": [ | |
| "0.5", | |
| "0.5" | |
| ], | |
| "color": { | |
| "main": "#1c4bb6", | |
| "second": "#ffffff" | |
| }, | |
| "icon": { | |
| "outline": false, | |
| "outlineColor": "#ffffff", | |
| "type": 1 , | |
| "shape": "circle" | |
| } | |
| } | |
| ``` | |
| ```json | |
| "Position": "left", | |
| "Menulang": "EN", | |
| "draggable": true, | |
| "btnStyle": { | |
| "vPosition": [ | |
| "80%", | |
| "80%" | |
| ], | |
| "margin": [ | |
| "0", | |
| "0" | |
| ], | |
| "scale": [ | |
| "0.5", | |
| "0.5" | |
| ], | |
| "color": { | |
| "main": "#1c4bb6", | |
| "second": "#ffffff" | |
| }, | |
| "icon": { | |
| "outline": false, | |
| "outlineColor": "#ffffff", | |
| "type": 1 , | |
| "shape": "circle" | |
| } | |
| } |
| 1. In the {{site.konnect_short_name}} sidebar, expand **{{site.dev_portal}}**. | ||
| 1. Click **Portals**. | ||
| 1. Click your {{site.dev_portal}}. | ||
| 1. Copy your {{site.dev_portal}} domain. This is the URL you'll register in EqualWeb. You can use either the default {{site.konnect_short_name}}-generated domain or your custom domain if you've configured one. |
There was a problem hiding this comment.
You can use either the default Konnect-generated domain or your custom domain if you’ve configured one.
During testing, I found this to not actually be the case. It's a bug/"feature" on the EqualWeb side, but they don't seem to respect separate subdomains under the same domain. Recommend removing the note about using the Konnect-generated Portal.
(unless you tried this and it worked; maybe I did something incorrectly)
| 1. Click **Continue to customize design**. | ||
| 1. Configure the widget design settings as needed. | ||
| 1. Click **Continue to install widget**. | ||
| 1. Click **Collapse** for your widget code. |
There was a problem hiding this comment.
Maybe worth clarifying that the point of pressing "Collapse" is to uncollapse the code sample and view the whole thing.
| 1. Configure the widget design settings as needed. | ||
| 1. Click **Continue to install widget**. | ||
| 1. Click **Collapse** for your widget code. | ||
| 1. Copy your site key from the `get sitekey (){ return "1234..."}` field. For example: `79ad2e1ec52e63565e254555077aaaec`. |
There was a problem hiding this comment.
Maybe change return "1234..." to return "79ad..." for consistency with your full sample key.
| ```json | ||
| "Position": "left", | ||
| "Menulang": "EN", | ||
| "draggable": true, | ||
| "btnStyle": { | ||
| "vPosition": [ | ||
| "80%", | ||
| "80%" | ||
| ], | ||
| "margin": [ | ||
| "0", | ||
| "0" | ||
| ], | ||
| "scale": [ | ||
| "0.5", | ||
| "0.5" | ||
| ], | ||
| "color": { | ||
| "main": "#1c4bb6", | ||
| "second": "#ffffff" | ||
| }, | ||
| "icon": { | ||
| "outline": false, | ||
| "outlineColor": "#ffffff", | ||
| "type": 1 , | ||
| "shape": "circle" | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
These docs are written into two parts: the EqualWeb side, and the Konnect side. I think the idea here is that what you're copying isn't JSON, but what you're submitting will be. Agree this could be made a little clearer though.
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Description
Fixes #4802
Preview Links
Checklist
descriptionentry in frontmatter.