docs(feedback): Document the new tags field - #10137

Merged
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs
Jun 21, 2024
Merged

docs(feedback): Document the new tags field#10137
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs

Conversation

@ryan953

@ryan953ryan953 commented May 23, 2024

Copy link
Copy Markdown
Member

Documents a new field added in getsentry/sentry-javascript#12197

Related to getsentry/sentry#71254

@vercel

vercelBot commented May 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackJun 17, 2024 9:02pm

@codecov

codecovBot commented May 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 12 bytes ⬇️

Bundle nameSizeChange
sentry-docs-edge-server461.86kB3 bytes ⬇️
sentry-docs-server7.42MB3 bytes ⬇️
sentry-docs-client6.18MB6 bytes ⬇️

Comment threaddocs/platforms/javascript/common/user-feedback/configuration/index.mdx Outdated
…ndex.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
| `showBranding` | `boolean` | `true` | Displays the Sentry logo inside of the form. |
| `colorScheme` | <code>"system" \| "light" \| "dark"</code> | `"system"` | Shows the color theme choices. `"system"` will use your OS color scheme. |
| `id` | `string` | `sentry-feedback` | The `id` attribute of the `<div>` that contains the feedback widget. See [CSS Customization](#css-customization) for more. |
| `tags` | `Record<string, number \| string \| boolean \| bigint \| symbol \| null \| undefined>` | `{}` | [Tags](/platforms/javascript/enriching-events/tags/) to set on the feedback event. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ryan953 you could use the PlatformLink component, instead of a markdown link. It would then link to the page for the base platform, but also on its guides. Otherwise, when you view the page for e.g. React, the link would be hardcoded to link to the page for the base platform.

ryan953 added a commit to getsentry/sentry-javascript that referenced this pull request Jun 17, 2024
…am (#12197)
We were missing the ability to set tags within feedback before, this
corrects it.
See getsentry/sentry-docs#10137 for the docs
update.
Now a developer can set `tags: {...}` anytime an options param is passed
into feedback. This includes:
- when we init the integration `feedbackIntegration({tags: {hello:
'world'}})`
- when attachTo is called: `feedback.attachTo(element, {tags: {hello:
'world'}})`
- when createWidget is called: `feedback.createWidget({tags: {hello:
'world'}})`
- when createForm is called: `feedback.createForm({tags: {hello:
'world'}})`
Users can also pass tags to `sendFeedback()` which is slightly nicer
than having to set them on scope first.
- `Sentry.sendFeedback({tags: {hello: 'world'}})` - `captureFeedback()` is unaffected, keeping it closer in style to the
other `capture*()` methods.
I also took the chance to re-use related types in more places. Checkout
the first 2 commits on the branch to see those changes individually.
Fixesgetsentry/sentry#71254
@ryan953

Copy link
Copy Markdown
MemberAuthor

The new tags field should be deployed with version 8.9.3 or 8.10, whatever comes first. I'll merge these docs then

https://github.com/getsentry/sentry-javascript/releases

@ryan953

Copy link
Copy Markdown
MemberAuthor

@ryan953
ryan953 merged commit 4beb3d7 into masterJun 21, 2024
@ryan953
ryan953 deleted the ryan953/12197-feedback-tags-docs branch June 21, 2024 16:30
ryan953 added a commit to getsentry/pokemon-market that referenced this pull request Jun 26, 2024
Depends on getsentry/sentry-javascript#12197
Follows instructions from
getsentry/sentry-docs#10137
---------
Co-authored-by: Catherine Lee <55311782+c298lee@users.noreply.github.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jul 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@ryan953@stephanie-anderson@vivianyentran@c298lee
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

docs(feedback): Document the new tags field - #10137

Merged
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs
Jun 21, 2024
Merged

docs(feedback): Document the new tags field#10137
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs

Conversation

@ryan953

@ryan953ryan953 commented May 23, 2024

Copy link
Copy Markdown
Member

Documents a new field added in getsentry/sentry-javascript#12197

Related to getsentry/sentry#71254

@vercel

vercelBot commented May 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackJun 17, 2024 9:02pm

@codecov

codecovBot commented May 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 12 bytes ⬇️

Bundle nameSizeChange
sentry-docs-edge-server461.86kB3 bytes ⬇️
sentry-docs-server7.42MB3 bytes ⬇️
sentry-docs-client6.18MB6 bytes ⬇️

Comment threaddocs/platforms/javascript/common/user-feedback/configuration/index.mdx Outdated
…ndex.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
| `showBranding` | `boolean` | `true` | Displays the Sentry logo inside of the form. |
| `colorScheme` | <code>"system" \| "light" \| "dark"</code> | `"system"` | Shows the color theme choices. `"system"` will use your OS color scheme. |
| `id` | `string` | `sentry-feedback` | The `id` attribute of the `<div>` that contains the feedback widget. See [CSS Customization](#css-customization) for more. |
| `tags` | `Record<string, number \| string \| boolean \| bigint \| symbol \| null \| undefined>` | `{}` | [Tags](/platforms/javascript/enriching-events/tags/) to set on the feedback event. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ryan953 you could use the PlatformLink component, instead of a markdown link. It would then link to the page for the base platform, but also on its guides. Otherwise, when you view the page for e.g. React, the link would be hardcoded to link to the page for the base platform.

ryan953 added a commit to getsentry/sentry-javascript that referenced this pull request Jun 17, 2024
…am (#12197)
We were missing the ability to set tags within feedback before, this
corrects it.
See getsentry/sentry-docs#10137 for the docs
update.
Now a developer can set `tags: {...}` anytime an options param is passed
into feedback. This includes:
- when we init the integration `feedbackIntegration({tags: {hello:
'world'}})`
- when attachTo is called: `feedback.attachTo(element, {tags: {hello:
'world'}})`
- when createWidget is called: `feedback.createWidget({tags: {hello:
'world'}})`
- when createForm is called: `feedback.createForm({tags: {hello:
'world'}})`
Users can also pass tags to `sendFeedback()` which is slightly nicer
than having to set them on scope first.
- `Sentry.sendFeedback({tags: {hello: 'world'}})` - `captureFeedback()` is unaffected, keeping it closer in style to the
other `capture*()` methods.
I also took the chance to re-use related types in more places. Checkout
the first 2 commits on the branch to see those changes individually.
Fixesgetsentry/sentry#71254
@ryan953

Copy link
Copy Markdown
MemberAuthor

The new tags field should be deployed with version 8.9.3 or 8.10, whatever comes first. I'll merge these docs then

https://github.com/getsentry/sentry-javascript/releases

@ryan953

Copy link
Copy Markdown
MemberAuthor

@ryan953
ryan953 merged commit 4beb3d7 into masterJun 21, 2024
@ryan953
ryan953 deleted the ryan953/12197-feedback-tags-docs branch June 21, 2024 16:30
ryan953 added a commit to getsentry/pokemon-market that referenced this pull request Jun 26, 2024
Depends on getsentry/sentry-javascript#12197
Follows instructions from
getsentry/sentry-docs#10137
---------
Co-authored-by: Catherine Lee <55311782+c298lee@users.noreply.github.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jul 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@ryan953@stephanie-anderson@vivianyentran@c298lee
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs(feedback): Document the new tags field - #10137

Merged
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs
Jun 21, 2024
Merged

docs(feedback): Document the new tags field#10137
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs

Conversation

@ryan953

@ryan953ryan953 commented May 23, 2024

Copy link
Copy Markdown
Member

Documents a new field added in getsentry/sentry-javascript#12197

Related to getsentry/sentry#71254

@vercel

vercelBot commented May 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackJun 17, 2024 9:02pm

@codecov

codecovBot commented May 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 12 bytes ⬇️

Bundle nameSizeChange
sentry-docs-edge-server461.86kB3 bytes ⬇️
sentry-docs-server7.42MB3 bytes ⬇️
sentry-docs-client6.18MB6 bytes ⬇️

Comment threaddocs/platforms/javascript/common/user-feedback/configuration/index.mdx Outdated
…ndex.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
| `showBranding` | `boolean` | `true` | Displays the Sentry logo inside of the form. |
| `colorScheme` | <code>"system" \| "light" \| "dark"</code> | `"system"` | Shows the color theme choices. `"system"` will use your OS color scheme. |
| `id` | `string` | `sentry-feedback` | The `id` attribute of the `<div>` that contains the feedback widget. See [CSS Customization](#css-customization) for more. |
| `tags` | `Record<string, number \| string \| boolean \| bigint \| symbol \| null \| undefined>` | `{}` | [Tags](/platforms/javascript/enriching-events/tags/) to set on the feedback event. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ryan953 you could use the PlatformLink component, instead of a markdown link. It would then link to the page for the base platform, but also on its guides. Otherwise, when you view the page for e.g. React, the link would be hardcoded to link to the page for the base platform.

ryan953 added a commit to getsentry/sentry-javascript that referenced this pull request Jun 17, 2024
…am (#12197)
We were missing the ability to set tags within feedback before, this
corrects it.
See getsentry/sentry-docs#10137 for the docs
update.
Now a developer can set `tags: {...}` anytime an options param is passed
into feedback. This includes:
- when we init the integration `feedbackIntegration({tags: {hello:
'world'}})`
- when attachTo is called: `feedback.attachTo(element, {tags: {hello:
'world'}})`
- when createWidget is called: `feedback.createWidget({tags: {hello:
'world'}})`
- when createForm is called: `feedback.createForm({tags: {hello:
'world'}})`
Users can also pass tags to `sendFeedback()` which is slightly nicer
than having to set them on scope first.
- `Sentry.sendFeedback({tags: {hello: 'world'}})` - `captureFeedback()` is unaffected, keeping it closer in style to the
other `capture*()` methods.
I also took the chance to re-use related types in more places. Checkout
the first 2 commits on the branch to see those changes individually.
Fixesgetsentry/sentry#71254
@ryan953

Copy link
Copy Markdown
MemberAuthor

The new tags field should be deployed with version 8.9.3 or 8.10, whatever comes first. I'll merge these docs then

https://github.com/getsentry/sentry-javascript/releases

@ryan953

Copy link
Copy Markdown
MemberAuthor

@ryan953
ryan953 merged commit 4beb3d7 into masterJun 21, 2024
@ryan953
ryan953 deleted the ryan953/12197-feedback-tags-docs branch June 21, 2024 16:30
ryan953 added a commit to getsentry/pokemon-market that referenced this pull request Jun 26, 2024
Depends on getsentry/sentry-javascript#12197
Follows instructions from
getsentry/sentry-docs#10137
---------
Co-authored-by: Catherine Lee <55311782+c298lee@users.noreply.github.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jul 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@ryan953@stephanie-anderson@vivianyentran@c298lee
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs(feedback): Document the new tags field - #10137

Merged
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs
Jun 21, 2024
Merged

docs(feedback): Document the new tags field#10137
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs

Conversation

@ryan953

@ryan953ryan953 commented May 23, 2024

Copy link
Copy Markdown
Member

Documents a new field added in getsentry/sentry-javascript#12197

Related to getsentry/sentry#71254

@vercel

vercelBot commented May 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackJun 17, 2024 9:02pm

@codecov

codecovBot commented May 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 12 bytes ⬇️

Bundle nameSizeChange
sentry-docs-edge-server461.86kB3 bytes ⬇️
sentry-docs-server7.42MB3 bytes ⬇️
sentry-docs-client6.18MB6 bytes ⬇️

Comment threaddocs/platforms/javascript/common/user-feedback/configuration/index.mdx Outdated
…ndex.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
| `showBranding` | `boolean` | `true` | Displays the Sentry logo inside of the form. |
| `colorScheme` | <code>"system" \| "light" \| "dark"</code> | `"system"` | Shows the color theme choices. `"system"` will use your OS color scheme. |
| `id` | `string` | `sentry-feedback` | The `id` attribute of the `<div>` that contains the feedback widget. See [CSS Customization](#css-customization) for more. |
| `tags` | `Record<string, number \| string \| boolean \| bigint \| symbol \| null \| undefined>` | `{}` | [Tags](/platforms/javascript/enriching-events/tags/) to set on the feedback event. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ryan953 you could use the PlatformLink component, instead of a markdown link. It would then link to the page for the base platform, but also on its guides. Otherwise, when you view the page for e.g. React, the link would be hardcoded to link to the page for the base platform.

ryan953 added a commit to getsentry/sentry-javascript that referenced this pull request Jun 17, 2024
…am (#12197)
We were missing the ability to set tags within feedback before, this
corrects it.
See getsentry/sentry-docs#10137 for the docs
update.
Now a developer can set `tags: {...}` anytime an options param is passed
into feedback. This includes:
- when we init the integration `feedbackIntegration({tags: {hello:
'world'}})`
- when attachTo is called: `feedback.attachTo(element, {tags: {hello:
'world'}})`
- when createWidget is called: `feedback.createWidget({tags: {hello:
'world'}})`
- when createForm is called: `feedback.createForm({tags: {hello:
'world'}})`
Users can also pass tags to `sendFeedback()` which is slightly nicer
than having to set them on scope first.
- `Sentry.sendFeedback({tags: {hello: 'world'}})` - `captureFeedback()` is unaffected, keeping it closer in style to the
other `capture*()` methods.
I also took the chance to re-use related types in more places. Checkout
the first 2 commits on the branch to see those changes individually.
Fixesgetsentry/sentry#71254
@ryan953

Copy link
Copy Markdown
MemberAuthor

The new tags field should be deployed with version 8.9.3 or 8.10, whatever comes first. I'll merge these docs then

https://github.com/getsentry/sentry-javascript/releases

@ryan953

Copy link
Copy Markdown
MemberAuthor

@ryan953
ryan953 merged commit 4beb3d7 into masterJun 21, 2024
@ryan953
ryan953 deleted the ryan953/12197-feedback-tags-docs branch June 21, 2024 16:30
ryan953 added a commit to getsentry/pokemon-market that referenced this pull request Jun 26, 2024
Depends on getsentry/sentry-javascript#12197
Follows instructions from
getsentry/sentry-docs#10137
---------
Co-authored-by: Catherine Lee <55311782+c298lee@users.noreply.github.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jul 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@ryan953@stephanie-anderson@vivianyentran@c298lee
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

docs(feedback): Document the new tags field - #10137

Merged
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs
Jun 21, 2024
Merged

docs(feedback): Document the new tags field#10137
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs

Conversation

@ryan953

@ryan953ryan953 commented May 23, 2024

Copy link
Copy Markdown
Member

Documents a new field added in getsentry/sentry-javascript#12197

Related to getsentry/sentry#71254

@vercel

vercelBot commented May 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackJun 17, 2024 9:02pm

@codecov

codecovBot commented May 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 12 bytes ⬇️

Bundle nameSizeChange
sentry-docs-edge-server461.86kB3 bytes ⬇️
sentry-docs-server7.42MB3 bytes ⬇️
sentry-docs-client6.18MB6 bytes ⬇️

Comment threaddocs/platforms/javascript/common/user-feedback/configuration/index.mdx Outdated
…ndex.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
| `showBranding` | `boolean` | `true` | Displays the Sentry logo inside of the form. |
| `colorScheme` | <code>"system" \| "light" \| "dark"</code> | `"system"` | Shows the color theme choices. `"system"` will use your OS color scheme. |
| `id` | `string` | `sentry-feedback` | The `id` attribute of the `<div>` that contains the feedback widget. See [CSS Customization](#css-customization) for more. |
| `tags` | `Record<string, number \| string \| boolean \| bigint \| symbol \| null \| undefined>` | `{}` | [Tags](/platforms/javascript/enriching-events/tags/) to set on the feedback event. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ryan953 you could use the PlatformLink component, instead of a markdown link. It would then link to the page for the base platform, but also on its guides. Otherwise, when you view the page for e.g. React, the link would be hardcoded to link to the page for the base platform.

ryan953 added a commit to getsentry/sentry-javascript that referenced this pull request Jun 17, 2024
…am (#12197)
We were missing the ability to set tags within feedback before, this
corrects it.
See getsentry/sentry-docs#10137 for the docs
update.
Now a developer can set `tags: {...}` anytime an options param is passed
into feedback. This includes:
- when we init the integration `feedbackIntegration({tags: {hello:
'world'}})`
- when attachTo is called: `feedback.attachTo(element, {tags: {hello:
'world'}})`
- when createWidget is called: `feedback.createWidget({tags: {hello:
'world'}})`
- when createForm is called: `feedback.createForm({tags: {hello:
'world'}})`
Users can also pass tags to `sendFeedback()` which is slightly nicer
than having to set them on scope first.
- `Sentry.sendFeedback({tags: {hello: 'world'}})` - `captureFeedback()` is unaffected, keeping it closer in style to the
other `capture*()` methods.
I also took the chance to re-use related types in more places. Checkout
the first 2 commits on the branch to see those changes individually.
Fixesgetsentry/sentry#71254
@ryan953

Copy link
Copy Markdown
MemberAuthor

The new tags field should be deployed with version 8.9.3 or 8.10, whatever comes first. I'll merge these docs then

https://github.com/getsentry/sentry-javascript/releases

@ryan953

Copy link
Copy Markdown
MemberAuthor

@ryan953
ryan953 merged commit 4beb3d7 into masterJun 21, 2024
@ryan953
ryan953 deleted the ryan953/12197-feedback-tags-docs branch June 21, 2024 16:30
ryan953 added a commit to getsentry/pokemon-market that referenced this pull request Jun 26, 2024
Depends on getsentry/sentry-javascript#12197
Follows instructions from
getsentry/sentry-docs#10137
---------
Co-authored-by: Catherine Lee <55311782+c298lee@users.noreply.github.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jul 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@ryan953@stephanie-anderson@vivianyentran@c298lee
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs(feedback): Document the new tags field - #10137

Merged
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs
Jun 21, 2024
Merged

docs(feedback): Document the new tags field#10137
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs

Conversation

@ryan953

@ryan953ryan953 commented May 23, 2024

Copy link
Copy Markdown
Member

Documents a new field added in getsentry/sentry-javascript#12197

Related to getsentry/sentry#71254

@vercel

vercelBot commented May 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackJun 17, 2024 9:02pm

@codecov

codecovBot commented May 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 12 bytes ⬇️

Bundle nameSizeChange
sentry-docs-edge-server461.86kB3 bytes ⬇️
sentry-docs-server7.42MB3 bytes ⬇️
sentry-docs-client6.18MB6 bytes ⬇️

Comment threaddocs/platforms/javascript/common/user-feedback/configuration/index.mdx Outdated
…ndex.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
| `showBranding` | `boolean` | `true` | Displays the Sentry logo inside of the form. |
| `colorScheme` | <code>"system" \| "light" \| "dark"</code> | `"system"` | Shows the color theme choices. `"system"` will use your OS color scheme. |
| `id` | `string` | `sentry-feedback` | The `id` attribute of the `<div>` that contains the feedback widget. See [CSS Customization](#css-customization) for more. |
| `tags` | `Record<string, number \| string \| boolean \| bigint \| symbol \| null \| undefined>` | `{}` | [Tags](/platforms/javascript/enriching-events/tags/) to set on the feedback event. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ryan953 you could use the PlatformLink component, instead of a markdown link. It would then link to the page for the base platform, but also on its guides. Otherwise, when you view the page for e.g. React, the link would be hardcoded to link to the page for the base platform.

ryan953 added a commit to getsentry/sentry-javascript that referenced this pull request Jun 17, 2024
…am (#12197)
We were missing the ability to set tags within feedback before, this
corrects it.
See getsentry/sentry-docs#10137 for the docs
update.
Now a developer can set `tags: {...}` anytime an options param is passed
into feedback. This includes:
- when we init the integration `feedbackIntegration({tags: {hello:
'world'}})`
- when attachTo is called: `feedback.attachTo(element, {tags: {hello:
'world'}})`
- when createWidget is called: `feedback.createWidget({tags: {hello:
'world'}})`
- when createForm is called: `feedback.createForm({tags: {hello:
'world'}})`
Users can also pass tags to `sendFeedback()` which is slightly nicer
than having to set them on scope first.
- `Sentry.sendFeedback({tags: {hello: 'world'}})` - `captureFeedback()` is unaffected, keeping it closer in style to the
other `capture*()` methods.
I also took the chance to re-use related types in more places. Checkout
the first 2 commits on the branch to see those changes individually.
Fixesgetsentry/sentry#71254
@ryan953

Copy link
Copy Markdown
MemberAuthor

The new tags field should be deployed with version 8.9.3 or 8.10, whatever comes first. I'll merge these docs then

https://github.com/getsentry/sentry-javascript/releases

@ryan953

Copy link
Copy Markdown
MemberAuthor

@ryan953
ryan953 merged commit 4beb3d7 into masterJun 21, 2024
@ryan953
ryan953 deleted the ryan953/12197-feedback-tags-docs branch June 21, 2024 16:30
ryan953 added a commit to getsentry/pokemon-market that referenced this pull request Jun 26, 2024
Depends on getsentry/sentry-javascript#12197
Follows instructions from
getsentry/sentry-docs#10137
---------
Co-authored-by: Catherine Lee <55311782+c298lee@users.noreply.github.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jul 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@ryan953@stephanie-anderson@vivianyentran@c298lee
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs(feedback): Document the new tags field - #10137

Merged
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs
Jun 21, 2024
Merged

docs(feedback): Document the new tags field#10137
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs

Conversation

@ryan953

@ryan953ryan953 commented May 23, 2024

Copy link
Copy Markdown
Member

Documents a new field added in getsentry/sentry-javascript#12197

Related to getsentry/sentry#71254

@vercel

vercelBot commented May 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackJun 17, 2024 9:02pm

@codecov

codecovBot commented May 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 12 bytes ⬇️

Bundle nameSizeChange
sentry-docs-edge-server461.86kB3 bytes ⬇️
sentry-docs-server7.42MB3 bytes ⬇️
sentry-docs-client6.18MB6 bytes ⬇️

Comment threaddocs/platforms/javascript/common/user-feedback/configuration/index.mdx Outdated
…ndex.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
| `showBranding` | `boolean` | `true` | Displays the Sentry logo inside of the form. |
| `colorScheme` | <code>"system" \| "light" \| "dark"</code> | `"system"` | Shows the color theme choices. `"system"` will use your OS color scheme. |
| `id` | `string` | `sentry-feedback` | The `id` attribute of the `<div>` that contains the feedback widget. See [CSS Customization](#css-customization) for more. |
| `tags` | `Record<string, number \| string \| boolean \| bigint \| symbol \| null \| undefined>` | `{}` | [Tags](/platforms/javascript/enriching-events/tags/) to set on the feedback event. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ryan953 you could use the PlatformLink component, instead of a markdown link. It would then link to the page for the base platform, but also on its guides. Otherwise, when you view the page for e.g. React, the link would be hardcoded to link to the page for the base platform.

ryan953 added a commit to getsentry/sentry-javascript that referenced this pull request Jun 17, 2024
…am (#12197)
We were missing the ability to set tags within feedback before, this
corrects it.
See getsentry/sentry-docs#10137 for the docs
update.
Now a developer can set `tags: {...}` anytime an options param is passed
into feedback. This includes:
- when we init the integration `feedbackIntegration({tags: {hello:
'world'}})`
- when attachTo is called: `feedback.attachTo(element, {tags: {hello:
'world'}})`
- when createWidget is called: `feedback.createWidget({tags: {hello:
'world'}})`
- when createForm is called: `feedback.createForm({tags: {hello:
'world'}})`
Users can also pass tags to `sendFeedback()` which is slightly nicer
than having to set them on scope first.
- `Sentry.sendFeedback({tags: {hello: 'world'}})` - `captureFeedback()` is unaffected, keeping it closer in style to the
other `capture*()` methods.
I also took the chance to re-use related types in more places. Checkout
the first 2 commits on the branch to see those changes individually.
Fixesgetsentry/sentry#71254
@ryan953

Copy link
Copy Markdown
MemberAuthor

The new tags field should be deployed with version 8.9.3 or 8.10, whatever comes first. I'll merge these docs then

https://github.com/getsentry/sentry-javascript/releases

@ryan953

Copy link
Copy Markdown
MemberAuthor

@ryan953
ryan953 merged commit 4beb3d7 into masterJun 21, 2024
@ryan953
ryan953 deleted the ryan953/12197-feedback-tags-docs branch June 21, 2024 16:30
ryan953 added a commit to getsentry/pokemon-market that referenced this pull request Jun 26, 2024
Depends on getsentry/sentry-javascript#12197
Follows instructions from
getsentry/sentry-docs#10137
---------
Co-authored-by: Catherine Lee <55311782+c298lee@users.noreply.github.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jul 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@ryan953@stephanie-anderson@vivianyentran@c298lee
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

docs(feedback): Document the new tags field - #10137

Merged
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs
Jun 21, 2024
Merged

docs(feedback): Document the new tags field#10137
ryan953 merged 3 commits into
masterfrom
ryan953/12197-feedback-tags-docs

Conversation

@ryan953

@ryan953ryan953 commented May 23, 2024

Copy link
Copy Markdown
Member

Documents a new field added in getsentry/sentry-javascript#12197

Related to getsentry/sentry#71254

@vercel

vercelBot commented May 23, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackJun 17, 2024 9:02pm

@codecov

codecovBot commented May 23, 2024

Copy link
Copy Markdown

Bundle Report

Changes will decrease total bundle size by 12 bytes ⬇️

Bundle nameSizeChange
sentry-docs-edge-server461.86kB3 bytes ⬇️
sentry-docs-server7.42MB3 bytes ⬇️
sentry-docs-client6.18MB6 bytes ⬇️

Comment threaddocs/platforms/javascript/common/user-feedback/configuration/index.mdx Outdated
…ndex.mdx
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
| `showBranding` | `boolean` | `true` | Displays the Sentry logo inside of the form. |
| `colorScheme` | <code>"system" \| "light" \| "dark"</code> | `"system"` | Shows the color theme choices. `"system"` will use your OS color scheme. |
| `id` | `string` | `sentry-feedback` | The `id` attribute of the `<div>` that contains the feedback widget. See [CSS Customization](#css-customization) for more. |
| `tags` | `Record<string, number \| string \| boolean \| bigint \| symbol \| null \| undefined>` | `{}` | [Tags](/platforms/javascript/enriching-events/tags/) to set on the feedback event. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ryan953 you could use the PlatformLink component, instead of a markdown link. It would then link to the page for the base platform, but also on its guides. Otherwise, when you view the page for e.g. React, the link would be hardcoded to link to the page for the base platform.

ryan953 added a commit to getsentry/sentry-javascript that referenced this pull request Jun 17, 2024
…am (#12197)
We were missing the ability to set tags within feedback before, this
corrects it.
See getsentry/sentry-docs#10137 for the docs
update.
Now a developer can set `tags: {...}` anytime an options param is passed
into feedback. This includes:
- when we init the integration `feedbackIntegration({tags: {hello:
'world'}})`
- when attachTo is called: `feedback.attachTo(element, {tags: {hello:
'world'}})`
- when createWidget is called: `feedback.createWidget({tags: {hello:
'world'}})`
- when createForm is called: `feedback.createForm({tags: {hello:
'world'}})`
Users can also pass tags to `sendFeedback()` which is slightly nicer
than having to set them on scope first.
- `Sentry.sendFeedback({tags: {hello: 'world'}})` - `captureFeedback()` is unaffected, keeping it closer in style to the
other `capture*()` methods.
I also took the chance to re-use related types in more places. Checkout
the first 2 commits on the branch to see those changes individually.
Fixesgetsentry/sentry#71254
@ryan953

Copy link
Copy Markdown
MemberAuthor

The new tags field should be deployed with version 8.9.3 or 8.10, whatever comes first. I'll merge these docs then

https://github.com/getsentry/sentry-javascript/releases

@ryan953

Copy link
Copy Markdown
MemberAuthor

@ryan953
ryan953 merged commit 4beb3d7 into masterJun 21, 2024
@ryan953
ryan953 deleted the ryan953/12197-feedback-tags-docs branch June 21, 2024 16:30
ryan953 added a commit to getsentry/pokemon-market that referenced this pull request Jun 26, 2024
Depends on getsentry/sentry-javascript#12197
Follows instructions from
getsentry/sentry-docs#10137
---------
Co-authored-by: Catherine Lee <55311782+c298lee@users.noreply.github.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jul 7, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@ryan953@stephanie-anderson@vivianyentran@c298lee