From 098d06cf23f4fa5ec16473bc2af31e6e8452ceac Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Mon, 20 Mar 2023 08:56:32 -0400 Subject: [PATCH 1/2] fix: Local anchors don't display in Docusaurus Signed-off-by: Adam Harvey --- docs/plugins/analytics.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/plugins/analytics.md b/docs/plugins/analytics.md index e04cb9c5c6..eee09a4185 100644 --- a/docs/plugins/analytics.md +++ b/docs/plugins/analytics.md @@ -61,16 +61,12 @@ installed, may be captured. | `discover` | The title of the search result that was clicked on | The `value` is the result rank. A `to` attribute is also provided | If there is an event you'd like to see captured, please [open an -issue][add-event] describing the event you want to see and the questions it -would help you answer. Or jump to [Capturing Events][event-howto] to learn how +issue](https://github.com/backstage/backstage/issues/new?assignees=&labels=enhancement&template=feature_template.md&title=[Analytics%20Event]:%20THE+EVENT+TO+CAPTURE) describing the event you want to see and the questions it +would help you answer. Or jump to [Capturing Events](#capturing-events) to learn how to contribute the instrumentation yourself! _OSS plugin maintainers: feel free to document your events in the table above._ -[add-event]: -https://github.com/backstage/backstage/issues/new?assignees=&labels=enhancement&template=feature_template.md&title=[Analytics%20Event]:%20THE+EVENT+TO+CAPTURE -[event-howto]: #capturing-events - ## Writing Integrations Analytics event forwarding is implemented as a Backstage utility API. Just as From c400203ac3da912485cb2d27be983540fea3da09 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Mon, 20 Mar 2023 09:12:07 -0400 Subject: [PATCH 2/2] chore: Cleanup and simplify Markdown table Signed-off-by: Adam Harvey --- docs/plugins/analytics.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/plugins/analytics.md b/docs/plugins/analytics.md index eee09a4185..e949f7beb4 100644 --- a/docs/plugins/analytics.md +++ b/docs/plugins/analytics.md @@ -52,13 +52,13 @@ learn how to contribute the integration yourself! The following table summarizes events that, depending on the plugins you have installed, may be captured. -| Action | Subject | Other Notes | -| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `navigate` | The URL of the page that was navigated to | | -| `click` | The text of the link that was clicked on | The `to` attribute represents the URL clicked to | -| `create` | The `name` of the software being created; if no `name` property is requested by the given Software Template, then the string `new {templateName}` is used instead. | The context holds an `entityRef`, set to the template's ref (e.g. `template:default/template-name`) | -| `search` | The search term entered in any search bar component | - The context holds `searchTypes`, representing `types` constraining the search. The `value` represents the total number of search results for the query. This may not be visible if the permission framework is being used. | -| `discover` | The title of the search result that was clicked on | The `value` is the result rank. A `to` attribute is also provided | +| Action | Subject | Other Notes | +| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `navigate` | The URL of the page that was navigated to. | | +| `click` | The text of the link that was clicked on. | The `to` attribute represents the URL clicked to. | +| `create` | The `name` of the software being created; if no `name` property is requested by the given Software Template, then the string `new {templateName}` is used instead. | The context holds an `entityRef`, set to the template's ref (e.g. `template:default/template-name`). | +| `search` | The search term entered in any search bar component. | The context holds `searchTypes`, representing `types` constraining the search. The `value` represents the total number of search results for the query. This may not be visible if the permission framework is being used. | +| `discover` | The title of the search result that was clicked on | The `value` is the result rank. A `to` attribute is also provided. | If there is an event you'd like to see captured, please [open an issue](https://github.com/backstage/backstage/issues/new?assignees=&labels=enhancement&template=feature_template.md&title=[Analytics%20Event]:%20THE+EVENT+TO+CAPTURE) describing the event you want to see and the questions it