-
Notifications
You must be signed in to change notification settings - Fork 108
feat(portal): EqualWeb integration #5673
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
cloudjumpercat
wants to merge
7
commits into
main
Choose a base branch
from
feat/equalweb
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
b251ceb
First draft
cloudjumpercat e5eebec
Revise how to
cloudjumpercat e08f456
Apply suggestions from code review
cloudjumpercat 7d50558
apply PM/eng feedback
cloudjumpercat cb5409d
Apply suggestions from code review
cloudjumpercat a8d45fd
shorten the one file
cloudjumpercat 92b0b5d
Apply suggestions from code review
cloudjumpercat File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| --- | ||
| title: "Add the EqualWeb accessibility widget to {{site.dev_portal}}" | ||
| permalink: /dev-portal/equalweb/ | ||
| description: "Learn how to add the EqualWeb accessibility widget to all pages of your {{site.konnect_short_name}} Dev Portal." | ||
| content_type: how_to | ||
| related_resources: | ||
| - text: About {{site.dev_portal}} | ||
| url: /dev-portal/ | ||
| - text: Add the Google Tag Manager script to {{site.dev_portal}} | ||
| url: /dev-portal/google-tag-manager/ | ||
| - text: Send {{site.dev_portal}} events data to Google Analytics | ||
| url: /dev-portal/google-analytics/ | ||
| automated_tests: false | ||
| products: | ||
| - dev-portal | ||
| - gateway | ||
| works_on: | ||
| - konnect | ||
|
|
||
| tldr: | ||
| q: How do I add EqualWeb to my {{site.dev_portal}}? | ||
| a: | | ||
| Configure the EqualWeb widget with your {{site.dev_portal}} domain. | ||
| In your {{site.dev_portal}} settings, click the **Integrations** tab and enable the EqualWeb integration. | ||
| Add your EqualWeb site key and widget configuration. | ||
| tags: | ||
| - accessibility | ||
| prereqs: | ||
| skip_product: true | ||
| inline: | ||
| - title: "{{site.dev_portal}}" | ||
| include_content: prereqs/dev-portal-create-ui | ||
| icon_url: /assets/icons/dev-portal.svg | ||
| - title: EqualWeb | ||
| content: | | ||
| You need an [EqualWeb](https://www.equalweb.com/) account. | ||
| icon_url: /assets/icons/third-party/equalwebicon.png | ||
| --- | ||
|
|
||
| You can add the [EqualWeb](https://www.equalweb.com/) accessibility widget to your {{site.dev_portal}} to help meet your organization's accessibility requirements. | ||
| After it's configured, the EqualWeb widget script will be injected into every page of your {{site.dev_portal}}. | ||
|
|
||
| ## Get your EqualWeb site key | ||
|
|
||
| Before you configure the integration in {{site.konnect_short_name}}, you need your {{site.dev_portal}} domain and your EqualWeb site key. | ||
|
|
||
| 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. | ||
| 1. In your EqualWeb account, click **Add new site**. | ||
| 1. In the **Insert your domain** field, enter your {{site.dev_portal}} domain. | ||
| 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. This will expand the widget configuration. | ||
| 1. Copy your site key from the `get sitekey (){ return "79ad2e1..."}` field. For example: `79ad2e1ec52e63565e254555077aaaec`. | ||
| 1. (Optional) If you configured the widget design, copy the configuration. For example: | ||
|
|
||
| ```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" | ||
| } | ||
| } | ||
| ``` | ||
|
cloudjumpercat marked this conversation as resolved.
|
||
| {:.collapsible .no-copy-code} | ||
|
|
||
| {:.info} | ||
| > The configuration you copy won't be valid JSON. When you add it to the {{site.dev_portal}} integration configuration, you'll add `{}` to make it valid. | ||
|
|
||
| ## Configure the EqualWeb integration | ||
|
|
||
| Configure the EqualWeb integration in your {{site.dev_portal}} settings. | ||
|
|
||
| 1. In the {{site.konnect_short_name}} sidebar, expand **{{site.dev_portal}}**. | ||
| 1. Click **Portals**. | ||
| 1. Click your {{site.dev_portal}}. | ||
| 1. Click the **Settings** tab. | ||
| 1. Click the **Integrations** tab. | ||
| 1. Click **EqualWeb**. | ||
| 1. Click the **Enabled** toggle. | ||
| 1. In the **Site key**, enter the site key from the EqualWeb widget you configured previously. For example: `79ad2e1ec52e63565e254555077aaaec`. | ||
| 1. (Optional) If you configured the widget design in EqualWeb, click **Advanced configurations** and enter the JSON configuration in the configuration field with opening and closing brackets (`{}`). For example: | ||
|
cloudjumpercat marked this conversation as resolved.
|
||
|
|
||
| ```json | ||
|
lena-larionova marked this conversation as resolved.
|
||
| { | ||
| "Position": "left", | ||
| "Menulang": "EN", | ||
| "draggable": true, | ||
| ... | ||
| } | ||
| ``` | ||
| {:.no-copy-code} | ||
| 1. Click **Save**. | ||
|
|
||
|
|
||
| You can also configure the EqualWeb integration using the {{site.konnect_short_name}} API by sending a `PUT` request to the [`/portals/{portalId}/integrations` endpoint](/api/konnect/portal-management/v3/#/operations/upsert-portal-integrations). | ||
|
|
||
| ## Validate | ||
|
|
||
| You can verify that the integration is working as expected by navigating to your {{site.dev_portal}} URL. | ||
| The EqualWeb accessibility widget should display on the page. | ||
| It can take several minutes to display the widget after you've enabled the integration. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.