From f94f5658a96e321e59efe335eb2a55d31c567c64 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Tue, 19 Apr 2022 11:43:28 +0200
Subject: [PATCH 01/14] techdocs-addons-contrib plugin including Report Issue
 Addon
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 plugins/techdocs-addons-contrib/.eslintrc.js  |   1 +
 plugins/techdocs-addons-contrib/api-report.md |  33 +++++
 plugins/techdocs-addons-contrib/dev/index.tsx |  30 ++++
 plugins/techdocs-addons-contrib/package.json  |  68 +++++++++
 .../src/ReportIssue/IssueLink.test.tsx        |  84 +++++++++++
 .../src/ReportIssue/IssueLink.tsx             |  83 +++++++++++
 .../src/ReportIssue/ReportIssue.tsx           | 132 ++++++++++++++++++
 .../src/ReportIssue/constants.ts              |  22 +++
 .../src/ReportIssue/hooks.ts                  |  96 +++++++++++++
 .../src/ReportIssue/index.ts                  |  19 +++
 .../src/ReportIssue/types.ts                  |  38 +++++
 plugins/techdocs-addons-contrib/src/index.ts  |  28 ++++
 .../src/plugin.test.ts                        |  22 +++
 plugins/techdocs-addons-contrib/src/plugin.ts |  46 ++++++
 .../techdocs-addons-contrib/src/setupTests.ts |  17 +++
 15 files changed, 719 insertions(+)
 create mode 100644 plugins/techdocs-addons-contrib/.eslintrc.js
 create mode 100644 plugins/techdocs-addons-contrib/api-report.md
 create mode 100644 plugins/techdocs-addons-contrib/dev/index.tsx
 create mode 100644 plugins/techdocs-addons-contrib/package.json
 create mode 100644 plugins/techdocs-addons-contrib/src/ReportIssue/IssueLink.test.tsx
 create mode 100644 plugins/techdocs-addons-contrib/src/ReportIssue/IssueLink.tsx
 create mode 100644 plugins/techdocs-addons-contrib/src/ReportIssue/ReportIssue.tsx
 create mode 100644 plugins/techdocs-addons-contrib/src/ReportIssue/constants.ts
 create mode 100644 plugins/techdocs-addons-contrib/src/ReportIssue/hooks.ts
 create mode 100644 plugins/techdocs-addons-contrib/src/ReportIssue/index.ts
 create mode 100644 plugins/techdocs-addons-contrib/src/ReportIssue/types.ts
 create mode 100644 plugins/techdocs-addons-contrib/src/index.ts
 create mode 100644 plugins/techdocs-addons-contrib/src/plugin.test.ts
 create mode 100644 plugins/techdocs-addons-contrib/src/plugin.ts
 create mode 100644 plugins/techdocs-addons-contrib/src/setupTests.ts

diff --git a/plugins/techdocs-addons-contrib/.eslintrc.js b/plugins/techdocs-addons-contrib/.eslintrc.js
new file mode 100644
index 0000000000..e2a53a6ad2
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/.eslintrc.js
@@ -0,0 +1 @@
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);
diff --git a/plugins/techdocs-addons-contrib/api-report.md b/plugins/techdocs-addons-contrib/api-report.md
new file mode 100644
index 0000000000..b02521f2e3
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/api-report.md
@@ -0,0 +1,33 @@
+## API Report File for "@backstage/plugin-techdocs-addons-contrib"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+/// <reference types="react" />
+
+import { BackstagePlugin } from '@backstage/core-plugin-api';
+import { ComponentType } from 'react';
+
+// @public
+export const ReportIssue: ComponentType<ReportIssueProps>;
+
+// @public (undocumented)
+export type ReportIssueProps = {
+  debounceTime?: number;
+  templateBuilder?: ReportIssueTemplateBuilder;
+};
+
+// @public (undocumented)
+export type ReportIssueTemplate = {
+  title: string;
+  body: string;
+};
+
+// @public (undocumented)
+export type ReportIssueTemplateBuilder = (
+  selection: Selection,
+) => ReportIssueTemplate;
+
+// @public
+export const techdocsAddonsContribPlugin: BackstagePlugin<{}, {}>;
+```
diff --git a/plugins/techdocs-addons-contrib/dev/index.tsx b/plugins/techdocs-addons-contrib/dev/index.tsx
new file mode 100644
index 0000000000..f220790022
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/dev/index.tsx
@@ -0,0 +1,30 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import React from 'react';
+import { createDevApp } from '@backstage/dev-utils';
+import {
+  techdocsAddonsContribPlugin,
+  TechdocsAddonsContribPage,
+} from '../src/plugin';
+
+createDevApp()
+  .registerPlugin(techdocsAddonsContribPlugin)
+  .addPage({
+    element: <TechdocsAddonsContribPage />,
+    title: 'Root Page',
+    path: '/techdocs-addons-contrib',
+  })
+  .render();
diff --git a/plugins/techdocs-addons-contrib/package.json b/plugins/techdocs-addons-contrib/package.json
new file mode 100644
index 0000000000..e0fd3126c6
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/package.json
@@ -0,0 +1,68 @@
+{
+  "name": "@backstage/plugin-techdocs-addons-contrib",
+  "description": "Plugin for contributed TechDocs Addons",
+  "version": "0.0.0",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "license": "Apache-2.0",
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "frontend-plugin"
+  },
+  "homepage": "https://backstage.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/techdocs-addons-contrib"
+  },
+  "keywords": [
+    "backstage",
+    "techdocs"
+  ],
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/core-components": "^0.9.3-next.1",
+    "@backstage/core-plugin-api": "^1.0.0",
+    "@backstage/integration": "^1.0.0",
+    "@backstage/integration-react": "^1.0.1-next.1",
+    "@backstage/plugin-techdocs-react": "^0.0.0",
+    "@backstage/theme": "^0.2.15",
+    "@material-ui/core": "^4.9.13",
+    "@material-ui/icons": "^4.9.1",
+    "@material-ui/lab": "4.0.0-alpha.57",
+    "git-url-parse": "^11.6.0",
+    "react-use": "^17.2.4"
+  },
+  "peerDependencies": {
+    "react": "^16.13.1 || ^17.0.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.17.0-next.2",
+    "@backstage/core-app-api": "^1.0.1-next.0",
+    "@backstage/dev-utils": "^1.0.1-next.0",
+    "@backstage/test-utils": "^1.0.1-next.1",
+    "@testing-library/jest-dom": "^5.10.1",
+    "@testing-library/react": "^12.1.3",
+    "@testing-library/user-event": "^14.0.0",
+    "@types/jest": "^26.0.7",
+    "@types/node": "^16.11.26",
+    "msw": "^0.35.0",
+    "cross-fetch": "^3.1.5"
+  },
+  "files": [
+    "dist"
+  ]
+}
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/IssueLink.test.tsx b/plugins/techdocs-addons-contrib/src/ReportIssue/IssueLink.test.tsx
new file mode 100644
index 0000000000..5fff56ecb7
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/src/ReportIssue/IssueLink.test.tsx
@@ -0,0 +1,84 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import React from 'react';
+import { render, screen, fireEvent, waitFor } from '@testing-library/react';
+
+import { analyticsApiRef } from '@backstage/core-plugin-api';
+import {
+  MockAnalyticsApi,
+  TestApiProvider,
+  wrapInTestApp,
+} from '@backstage/test-utils';
+
+import { IssueLink } from './IssueLink';
+
+const defaultProps = {
+  repository: {
+    type: 'github',
+    name: 'backstage',
+    owner: 'backstage',
+    protocol: 'https',
+    resource: 'github.com',
+  },
+  template: {
+    title: 'Documentation feedback',
+    body: '## Documentation Feedback 📝',
+  },
+};
+
+describe('FeedbackLink', () => {
+  const apiSpy = new MockAnalyticsApi();
+
+  it('Should open new issue tab', () => {
+    render(
+      wrapInTestApp(
+        <TestApiProvider apis={[[analyticsApiRef, apiSpy]]}>
+          <IssueLink {...defaultProps} />
+        </TestApiProvider>,
+      ),
+    );
+
+    const link = screen.getByText(/Open new Github issue/);
+    expect(link).toBeInTheDocument();
+    expect(link).toHaveAttribute('target', '_blank');
+    const encodedTitle = encodeURIComponent(defaultProps.template.title);
+    const encodedBody = encodeURIComponent(defaultProps.template.body);
+    expect(link).toHaveAttribute(
+      'href',
+      `https://github.com/backstage/backstage/issues/new?title=${encodedTitle}&body=${encodedBody}`,
+    );
+  });
+
+  it('Should track click events', async () => {
+    render(
+      wrapInTestApp(
+        <TestApiProvider apis={[[analyticsApiRef, apiSpy]]}>
+          <IssueLink {...defaultProps} />
+        </TestApiProvider>,
+      ),
+    );
+
+    fireEvent.click(screen.getByText(/Open new Github issue/));
+
+    await waitFor(() => {
+      expect(apiSpy.getEvents()[0]).toMatchObject({
+        action: 'click',
+        subject: 'Open new  Github  issue',
+      });
+    });
+  });
+});
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/IssueLink.tsx b/plugins/techdocs-addons-contrib/src/ReportIssue/IssueLink.tsx
new file mode 100644
index 0000000000..0a1a64218a
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/src/ReportIssue/IssueLink.tsx
@@ -0,0 +1,83 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import React from 'react';
+
+import { makeStyles } from '@material-ui/core';
+import BugReportIcon from '@material-ui/icons/BugReport';
+
+import { Link, GitHubIcon } from '@backstage/core-components';
+
+import { ReportIssueTemplate, Repository } from './types';
+
+const useStyles = makeStyles(theme => ({
+  root: {
+    display: 'grid',
+    gridGap: theme.spacing(1),
+    gridAutoFlow: 'column',
+    justifyContent: 'center',
+    alignItems: 'center',
+    color: theme.palette.common.black,
+    fontSize: theme.typography.button.fontSize,
+  },
+}));
+
+type IssueLinkProps = {
+  template: ReportIssueTemplate;
+  repository: Repository;
+};
+
+const getIcon = ({ type }: Repository) => {
+  if (type === 'github') {
+    return GitHubIcon;
+  }
+  return BugReportIcon;
+};
+
+const getName = ({ type }: Repository) => {
+  if (type === 'github') {
+    return 'Github';
+  }
+  return 'Gitlab';
+};
+
+const getUrl = (repository: Repository, template: ReportIssueTemplate) => {
+  const { title, body } = template;
+  const encodedTitle = encodeURIComponent(title);
+  const encodedBody = encodeURIComponent(body);
+  const { protocol, resource, owner, name, type } = repository;
+  const encodedOwner = encodeURIComponent(owner);
+  const encodedName = encodeURIComponent(name);
+
+  const url = `${protocol}://${resource}/${encodedOwner}/${encodedName}`;
+  if (type === 'github') {
+    return `${url}/issues/new?title=${encodedTitle}&body=${encodedBody}`;
+  }
+  return `${url}/issues/new?[title]=${encodedTitle}&[body]=${encodedBody}`;
+};
+
+export const IssueLink = ({ template, repository }: IssueLinkProps) => {
+  const classes = useStyles();
+
+  const Icon = getIcon(repository);
+  const url = getUrl(repository, template);
+
+  return (
+    <Link className={classes.root} to={url} target="_blank">
+      <Icon /> Open new {getName(repository)} issue
+    </Link>
+  );
+};
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/ReportIssue.tsx b/plugins/techdocs-addons-contrib/src/ReportIssue/ReportIssue.tsx
new file mode 100644
index 0000000000..21f0317b3a
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/src/ReportIssue/ReportIssue.tsx
@@ -0,0 +1,132 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import React, { useState, useEffect } from 'react';
+
+import { makeStyles, Portal, Paper } from '@material-ui/core';
+
+import { useGitTemplate, useGitRepository } from './hooks';
+import { ReportIssueTemplateBuilder } from './types';
+import {
+  PAGE_MAIN_CONTENT_SELECTOR,
+  PAGE_FEEDBACK_LINK_SELECTOR,
+  ADDON_FEEDBACK_CONTAINER_ID,
+  ADDON_FEEDBACK_CONTAINER_SELECTOR,
+} from './constants';
+import { IssueLink } from './IssueLink';
+
+import {
+  useShadowRootElements,
+  useShadowRootSelection,
+} from '@backstage/plugin-techdocs-react';
+
+const useStyles = makeStyles(theme => ({
+  root: {
+    transform: 'translate(-100%, -100%)',
+    position: 'absolute',
+    padding: theme.spacing(1),
+    zIndex: theme.zIndex.tooltip,
+    background: theme.palette.common.white,
+  },
+}));
+
+type Style = {
+  top: string;
+  left: string;
+};
+
+/**
+ * @public
+ */
+export type ReportIssueProps = {
+  debounceTime?: number;
+  templateBuilder?: ReportIssueTemplateBuilder;
+};
+
+/**
+ * Show report issue button when text is highlighted
+ */
+export const ReportIssueAddon = ({
+  debounceTime = 500,
+  templateBuilder: buildTemplate,
+}: ReportIssueProps) => {
+  const classes = useStyles();
+  const [style, setStyle] = useState<Style>();
+
+  const repository = useGitRepository();
+
+  const defaultTemplate = useGitTemplate(debounceTime);
+
+  const selection = useShadowRootSelection(debounceTime);
+
+  const [mainContent, feedbackLink] = useShadowRootElements([
+    PAGE_MAIN_CONTENT_SELECTOR,
+    PAGE_FEEDBACK_LINK_SELECTOR,
+  ]);
+
+  let [feedbackContainer] = useShadowRootElements([
+    ADDON_FEEDBACK_CONTAINER_SELECTOR,
+  ]);
+
+  if (feedbackLink) {
+    feedbackLink.style.display = 'none';
+  }
+
+  // calculates the position of the selected text to be able to set the position of the addon
+  useEffect(() => {
+    if (
+      // todo(backstage/techdocs-core) handle non-repo rendering
+      !repository ||
+      !selection ||
+      !selection.containsNode(mainContent!, true) ||
+      selection?.containsNode(feedbackContainer!, true)
+    ) {
+      return;
+    }
+
+    const mainContentPosition = mainContent!.getBoundingClientRect();
+    const selectionPosition = selection.getRangeAt(0).getBoundingClientRect();
+
+    setStyle({
+      top: `${selectionPosition.top - mainContentPosition.top - 16}px`,
+      left: `${selectionPosition.left + selectionPosition.width / 2}px`,
+    });
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [selection, mainContent, feedbackContainer]);
+
+  if (!selection || !repository) return null;
+
+  if (!feedbackContainer) {
+    feedbackContainer = document.createElement('div');
+    feedbackContainer.setAttribute('id', ADDON_FEEDBACK_CONTAINER_ID);
+    mainContent!.prepend(feedbackContainer);
+  }
+
+  return (
+    <Portal container={feedbackContainer}>
+      <Paper
+        data-testid="report-issue-addon"
+        className={classes.root}
+        style={style}
+      >
+        <IssueLink
+          repository={repository}
+          template={buildTemplate ? buildTemplate(selection) : defaultTemplate}
+        />
+      </Paper>
+    </Portal>
+  );
+};
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/constants.ts b/plugins/techdocs-addons-contrib/src/ReportIssue/constants.ts
new file mode 100644
index 0000000000..0bf686cb73
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/src/ReportIssue/constants.ts
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export const ADDON_FEEDBACK_CONTAINER_ID = 'techdocs-report-issue';
+export const ADDON_FEEDBACK_CONTAINER_SELECTOR = `#${ADDON_FEEDBACK_CONTAINER_ID}`;
+export const PAGE_EDIT_LINK_SELECTOR = '[title^="Edit this page"]';
+export const PAGE_FEEDBACK_LINK_SELECTOR = '[title^="Leave feedback for"]';
+export const PAGE_MAIN_CONTENT_SELECTOR =
+  '[data-md-component="main"] .md-content';
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/hooks.ts b/plugins/techdocs-addons-contrib/src/ReportIssue/hooks.ts
new file mode 100644
index 0000000000..a124f2978f
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/src/ReportIssue/hooks.ts
@@ -0,0 +1,96 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import parseGitUrl from 'git-url-parse';
+
+import { useApi } from '@backstage/core-plugin-api';
+import {
+  replaceGitHubUrlType,
+  replaceGitLabUrlType,
+} from '@backstage/integration';
+import { scmIntegrationsApiRef } from '@backstage/integration-react';
+import {
+  useShadowRootElements,
+  useShadowRootSelection,
+} from '@backstage/plugin-techdocs-react';
+
+import { PAGE_EDIT_LINK_SELECTOR } from './constants';
+
+const resolveBlobUrl = (url: string, type: string) => {
+  if (type === 'github') {
+    return replaceGitHubUrlType(url, 'blob');
+  }
+  return replaceGitLabUrlType(url, 'blob');
+};
+
+export const getTitle = (selection: Selection) => {
+  const text = selection.toString().substring(0, 70);
+  const ellipsis = text.length === 70 ? '...' : '';
+  return `Documentation feedback: ${text}${ellipsis}`;
+};
+
+export const getBody = (selection: Selection, markdownUrl: string) => {
+  const title = '## Documentation Feedback 📝';
+  const subheading = '#### The highlighted text:';
+  const commentHeading = '#### The comment on the text:';
+  const commentPlaceholder = '_>replace this line with your comment<_';
+  const highlightedTextAsQuote = selection
+    .toString()
+    .trim()
+    .split('\n')
+    .map(line => `> ${line.trim()}`)
+    .join('\n');
+
+  const facts = [
+    `Backstage URL: <${window.location.href}> \nMarkdown URL: <${markdownUrl}>`,
+  ];
+
+  return `${title}\n\n ${subheading} \n\n ${highlightedTextAsQuote}\n\n ${commentHeading} \n ${commentPlaceholder}\n\n ___\n${facts}`;
+};
+
+export const useGitTemplate = (debounceTime?: number) => {
+  const initialTemplate = { title: '', body: '' };
+  const selection = useShadowRootSelection(debounceTime);
+  const [editLink] = useShadowRootElements([PAGE_EDIT_LINK_SELECTOR]);
+  const url = (editLink as HTMLAnchorElement)?.href ?? '';
+  const scmIntegrationsApi = useApi(scmIntegrationsApiRef);
+
+  if (!selection || !url) return initialTemplate;
+
+  const type = scmIntegrationsApi.byUrl(url)?.type;
+
+  if (!type) return initialTemplate;
+
+  return {
+    title: getTitle(selection),
+    body: getBody(selection, resolveBlobUrl(url, type)),
+  };
+};
+
+export const useGitRepository = () => {
+  const scmIntegrationsApi = useApi(scmIntegrationsApiRef);
+
+  const [editLink] = useShadowRootElements([PAGE_EDIT_LINK_SELECTOR]);
+  const url = (editLink as HTMLAnchorElement)?.href ?? '';
+
+  if (!url) return null;
+
+  const type = scmIntegrationsApi.byUrl(url)?.type;
+
+  if (!type) return null;
+
+  return { ...parseGitUrl(resolveBlobUrl(url, type)), type };
+};
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/index.ts b/plugins/techdocs-addons-contrib/src/ReportIssue/index.ts
new file mode 100644
index 0000000000..ae18c78bf0
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/src/ReportIssue/index.ts
@@ -0,0 +1,19 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { ReportIssueAddon } from './ReportIssue';
+export type { ReportIssueProps } from './ReportIssue';
+export type { ReportIssueTemplate, ReportIssueTemplateBuilder } from './types';
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/types.ts b/plugins/techdocs-addons-contrib/src/ReportIssue/types.ts
new file mode 100644
index 0000000000..94d1107822
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/src/ReportIssue/types.ts
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @public
+ */
+export type ReportIssueTemplate = {
+  title: string;
+  body: string;
+};
+
+/**
+ * @public
+ */
+export type ReportIssueTemplateBuilder = (
+  selection: Selection,
+) => ReportIssueTemplate;
+
+export type Repository = {
+  type: string;
+  name: string;
+  owner: string;
+  protocol: string;
+  resource: string;
+};
diff --git a/plugins/techdocs-addons-contrib/src/index.ts b/plugins/techdocs-addons-contrib/src/index.ts
new file mode 100644
index 0000000000..ed89ba976b
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/src/index.ts
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * A plugin for contributed TechDocs Addons.
+ *
+ * @packageDocumentation
+ */
+
+export { techdocsAddonsContribPlugin, ReportIssue } from './plugin';
+export type {
+  ReportIssueProps,
+  ReportIssueTemplate,
+  ReportIssueTemplateBuilder,
+} from './ReportIssue';
diff --git a/plugins/techdocs-addons-contrib/src/plugin.test.ts b/plugins/techdocs-addons-contrib/src/plugin.test.ts
new file mode 100644
index 0000000000..071623fc4f
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/src/plugin.test.ts
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { techdocsAddonsContribPlugin } from './plugin';
+
+describe('techdocs-addons-contrib', () => {
+  it('should export plugin', () => {
+    expect(techdocsAddonsContribPlugin).toBeDefined();
+  });
+});
diff --git a/plugins/techdocs-addons-contrib/src/plugin.ts b/plugins/techdocs-addons-contrib/src/plugin.ts
new file mode 100644
index 0000000000..b004300f3a
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/src/plugin.ts
@@ -0,0 +1,46 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { createPlugin } from '@backstage/core-plugin-api';
+import {
+  createTechDocsAddon,
+  TechDocsAddonLocations,
+} from '@backstage/plugin-techdocs-react';
+import { ReportIssueAddon, ReportIssueProps } from './ReportIssue';
+
+/**
+ * The TechDocs addons contrib plugin
+ *
+ * @public
+ */
+
+export const techdocsAddonsContribPlugin = createPlugin({
+  id: 'techdocsAddonsContrib',
+});
+
+/**
+ * TechDocs addon that lets you select text and open GitHub/Gitlab issues
+ *
+ * @public
+ */
+
+export const ReportIssue = techdocsAddonsContribPlugin.provide(
+  createTechDocsAddon<ReportIssueProps>({
+    name: 'ReportIssue',
+    location: TechDocsAddonLocations.CONTENT,
+    component: ReportIssueAddon,
+  }),
+);
diff --git a/plugins/techdocs-addons-contrib/src/setupTests.ts b/plugins/techdocs-addons-contrib/src/setupTests.ts
new file mode 100644
index 0000000000..9bb3e72355
--- /dev/null
+++ b/plugins/techdocs-addons-contrib/src/setupTests.ts
@@ -0,0 +1,17 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import '@testing-library/jest-dom';
+import 'cross-fetch/polyfill';

From f0a4ae8c3486324db054c20c20ee99719d333907 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Tue, 19 Apr 2022 11:50:14 +0200
Subject: [PATCH 02/14] add Report Issue Addon to Apps
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 packages/app/package.json                       | 2 ++
 packages/app/src/App.tsx                        | 5 +++++
 packages/techdocs-cli-embedded-app/package.json | 1 +
 packages/techdocs-cli-embedded-app/src/App.tsx  | 2 ++
 4 files changed, 10 insertions(+)

diff --git a/packages/app/package.json b/packages/app/package.json
index 08e266ad83..708e7f247f 100644
--- a/packages/app/package.json
+++ b/packages/app/package.json
@@ -55,6 +55,8 @@
     "@backstage/plugin-stack-overflow": "^0.1.0",
     "@backstage/plugin-tech-radar": "^0.5.11",
     "@backstage/plugin-techdocs": "^1.1.0",
+    "@backstage/plugin-techdocs-react": "^0.1.0",
+    "@backstage/plugin-techdocs-addons-contrib": "^0.0.0",
     "@backstage/plugin-todo": "^0.2.6",
     "@backstage/plugin-user-settings": "^0.4.3",
     "@backstage/plugin-tech-insights": "^0.2.0",
diff --git a/packages/app/src/App.tsx b/packages/app/src/App.tsx
index ac0b9daa52..9f2f190e60 100644
--- a/packages/app/src/App.tsx
+++ b/packages/app/src/App.tsx
@@ -69,6 +69,8 @@ import {
   TechDocsReaderPage,
   techdocsPlugin,
 } from '@backstage/plugin-techdocs';
+import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
+import { ReportIssue } from '@backstage/plugin-techdocs-addons-contrib';
 import {
   UserSettingsPage,
   UserSettingsTab,
@@ -179,6 +181,9 @@ const routes = (
       element={<TechDocsReaderPage />}
     >
       {techDocsPage}
+      <TechDocsAddons>
+        <ReportIssue />
+      </TechDocsAddons>
     </Route>
     <Route
       path="/create"
diff --git a/packages/techdocs-cli-embedded-app/package.json b/packages/techdocs-cli-embedded-app/package.json
index b438a8d7f9..b9fced8583 100644
--- a/packages/techdocs-cli-embedded-app/package.json
+++ b/packages/techdocs-cli-embedded-app/package.json
@@ -18,6 +18,7 @@
     "@backstage/plugin-catalog": "^1.1.0",
     "@backstage/plugin-techdocs": "^1.1.0",
     "@backstage/plugin-techdocs-react": "^0.1.0",
+    "@backstage/plugin-techdocs-addons-contrib": "^0.0.0",
     "@backstage/test-utils": "^1.0.1",
     "@backstage/theme": "^0.2.15",
     "@material-ui/core": "^4.11.0",
diff --git a/packages/techdocs-cli-embedded-app/src/App.tsx b/packages/techdocs-cli-embedded-app/src/App.tsx
index 194d26943d..4596ff70e7 100644
--- a/packages/techdocs-cli-embedded-app/src/App.tsx
+++ b/packages/techdocs-cli-embedded-app/src/App.tsx
@@ -28,6 +28,7 @@ import {
   TechDocsAddons,
   TechDocsAddonLocations,
 } from '@backstage/plugin-techdocs-react';
+import { ReportIssue } from '@backstage/plugin-techdocs-addons-contrib';
 import { createApp } from '@backstage/app-defaults';
 import { FlatRoutes } from '@backstage/core-app-api';
 import { CatalogEntityPage } from '@backstage/plugin-catalog';
@@ -72,6 +73,7 @@ const routes = (
     >
       {techDocsPage}
       <TechDocsAddons>
+        <ReportIssue />
         <ThemeToggleAddon />
       </TechDocsAddons>
     </Route>

From 5f4dbd2b522dcaf465916dda6337ac32fe87ec64 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Tue, 19 Apr 2022 12:14:59 +0200
Subject: [PATCH 03/14] changeset
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 .changeset/techdocs-quick-owls-smile.md | 7 +++++++
 1 file changed, 7 insertions(+)
 create mode 100644 .changeset/techdocs-quick-owls-smile.md

diff --git a/.changeset/techdocs-quick-owls-smile.md b/.changeset/techdocs-quick-owls-smile.md
new file mode 100644
index 0000000000..7513e836ce
--- /dev/null
+++ b/.changeset/techdocs-quick-owls-smile.md
@@ -0,0 +1,7 @@
+---
+'@backstage/plugin-techdocs-addons-contrib': minor
+---
+
+A package for contributed TechDocs addons.
+
+In this release it will introduce the ReportIssue addon, which lets you select text and open a GitHub/Gitlab issue.

From 5781ba4c27e5e3d329080636b7fdba8008908f87 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Tue, 19 Apr 2022 13:17:43 +0200
Subject: [PATCH 04/14] use correct @backstage/plugin-techdocs-react version
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 plugins/techdocs-addons-contrib/package.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/plugins/techdocs-addons-contrib/package.json b/plugins/techdocs-addons-contrib/package.json
index e0fd3126c6..7f0472dbba 100644
--- a/plugins/techdocs-addons-contrib/package.json
+++ b/plugins/techdocs-addons-contrib/package.json
@@ -38,7 +38,7 @@
     "@backstage/core-plugin-api": "^1.0.0",
     "@backstage/integration": "^1.0.0",
     "@backstage/integration-react": "^1.0.1-next.1",
-    "@backstage/plugin-techdocs-react": "^0.0.0",
+    "@backstage/plugin-techdocs-react": "^0.1.0-next.0",
     "@backstage/theme": "^0.2.15",
     "@material-ui/core": "^4.9.13",
     "@material-ui/icons": "^4.9.1",

From c9097b4d9dea9754b310d10eee5155a6689518f0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Tue, 19 Apr 2022 13:37:58 +0200
Subject: [PATCH 05/14] fix oopsies after rebase
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 plugins/techdocs-addons-contrib/dev/index.tsx | 30 -------------------
 plugins/techdocs-addons-contrib/package.json  |  2 +-
 plugins/techdocs-addons-contrib/src/plugin.ts |  6 ++--
 3 files changed, 4 insertions(+), 34 deletions(-)
 delete mode 100644 plugins/techdocs-addons-contrib/dev/index.tsx

diff --git a/plugins/techdocs-addons-contrib/dev/index.tsx b/plugins/techdocs-addons-contrib/dev/index.tsx
deleted file mode 100644
index f220790022..0000000000
--- a/plugins/techdocs-addons-contrib/dev/index.tsx
+++ /dev/null
@@ -1,30 +0,0 @@
-/*
- * Copyright 2022 The Backstage Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import React from 'react';
-import { createDevApp } from '@backstage/dev-utils';
-import {
-  techdocsAddonsContribPlugin,
-  TechdocsAddonsContribPage,
-} from '../src/plugin';
-
-createDevApp()
-  .registerPlugin(techdocsAddonsContribPlugin)
-  .addPage({
-    element: <TechdocsAddonsContribPage />,
-    title: 'Root Page',
-    path: '/techdocs-addons-contrib',
-  })
-  .render();
diff --git a/plugins/techdocs-addons-contrib/package.json b/plugins/techdocs-addons-contrib/package.json
index 7f0472dbba..28a77044ef 100644
--- a/plugins/techdocs-addons-contrib/package.json
+++ b/plugins/techdocs-addons-contrib/package.json
@@ -36,7 +36,7 @@
   "dependencies": {
     "@backstage/core-components": "^0.9.3-next.1",
     "@backstage/core-plugin-api": "^1.0.0",
-    "@backstage/integration": "^1.0.0",
+    "@backstage/integration": "^1.1.0-next.2",
     "@backstage/integration-react": "^1.0.1-next.1",
     "@backstage/plugin-techdocs-react": "^0.1.0-next.0",
     "@backstage/theme": "^0.2.15",
diff --git a/plugins/techdocs-addons-contrib/src/plugin.ts b/plugins/techdocs-addons-contrib/src/plugin.ts
index b004300f3a..f29d6ed5dd 100644
--- a/plugins/techdocs-addons-contrib/src/plugin.ts
+++ b/plugins/techdocs-addons-contrib/src/plugin.ts
@@ -16,7 +16,7 @@
 
 import { createPlugin } from '@backstage/core-plugin-api';
 import {
-  createTechDocsAddon,
+  createTechDocsAddonExtension,
   TechDocsAddonLocations,
 } from '@backstage/plugin-techdocs-react';
 import { ReportIssueAddon, ReportIssueProps } from './ReportIssue';
@@ -38,9 +38,9 @@ export const techdocsAddonsContribPlugin = createPlugin({
  */
 
 export const ReportIssue = techdocsAddonsContribPlugin.provide(
-  createTechDocsAddon<ReportIssueProps>({
+  createTechDocsAddonExtension<ReportIssueProps>({
     name: 'ReportIssue',
-    location: TechDocsAddonLocations.CONTENT,
+    location: TechDocsAddonLocations.Content,
     component: ReportIssueAddon,
   }),
 );

From 62068114ad90b6bff9f0a380e165b1988f5a0419 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Tue, 19 Apr 2022 13:54:10 +0200
Subject: [PATCH 06/14] bump package versions
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 plugins/techdocs-addons-contrib/package.json | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/plugins/techdocs-addons-contrib/package.json b/plugins/techdocs-addons-contrib/package.json
index 28a77044ef..1a71d01f14 100644
--- a/plugins/techdocs-addons-contrib/package.json
+++ b/plugins/techdocs-addons-contrib/package.json
@@ -34,8 +34,8 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/core-components": "^0.9.3-next.1",
-    "@backstage/core-plugin-api": "^1.0.0",
+    "@backstage/core-components": "^0.9.3-next.2",
+    "@backstage/core-plugin-api": "^1.0.1-next.0",
     "@backstage/integration": "^1.1.0-next.2",
     "@backstage/integration-react": "^1.0.1-next.1",
     "@backstage/plugin-techdocs-react": "^0.1.0-next.0",
@@ -50,10 +50,10 @@
     "react": "^16.13.1 || ^17.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.17.0-next.2",
-    "@backstage/core-app-api": "^1.0.1-next.0",
-    "@backstage/dev-utils": "^1.0.1-next.0",
-    "@backstage/test-utils": "^1.0.1-next.1",
+    "@backstage/cli": "^0.17.0-next.3",
+    "@backstage/core-app-api": "^1.0.1-next.1",
+    "@backstage/dev-utils": "^1.0.1-next.1",
+    "@backstage/test-utils": "^1.0.1-next.2",
     "@testing-library/jest-dom": "^5.10.1",
     "@testing-library/react": "^12.1.3",
     "@testing-library/user-event": "^14.0.0",

From 9d5481c523306b4b0440990a76d94577909c7fa5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Wed, 20 Apr 2022 09:43:08 +0200
Subject: [PATCH 07/14] add @types/react dependency
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 plugins/techdocs-addons-contrib/package.json | 1 +
 1 file changed, 1 insertion(+)

diff --git a/plugins/techdocs-addons-contrib/package.json b/plugins/techdocs-addons-contrib/package.json
index 1a71d01f14..82a687e12f 100644
--- a/plugins/techdocs-addons-contrib/package.json
+++ b/plugins/techdocs-addons-contrib/package.json
@@ -47,6 +47,7 @@
     "react-use": "^17.2.4"
   },
   "peerDependencies": {
+    "@types/react": "^16.13.1 || ^17.0.0",
     "react": "^16.13.1 || ^17.0.0"
   },
   "devDependencies": {

From cd01632ee2c4b479870192ffbfecee94db22349b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Wed, 20 Apr 2022 10:17:32 +0200
Subject: [PATCH 08/14] version bumpage
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 plugins/techdocs-addons-contrib/package.json | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/plugins/techdocs-addons-contrib/package.json b/plugins/techdocs-addons-contrib/package.json
index 82a687e12f..a2f25f9607 100644
--- a/plugins/techdocs-addons-contrib/package.json
+++ b/plugins/techdocs-addons-contrib/package.json
@@ -34,11 +34,11 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/core-components": "^0.9.3-next.2",
-    "@backstage/core-plugin-api": "^1.0.1-next.0",
-    "@backstage/integration": "^1.1.0-next.2",
-    "@backstage/integration-react": "^1.0.1-next.1",
-    "@backstage/plugin-techdocs-react": "^0.1.0-next.0",
+    "@backstage/core-components": "^0.9.3",
+    "@backstage/core-plugin-api": "^1.0.1",
+    "@backstage/integration": "^1.1.0",
+    "@backstage/integration-react": "^1.0.1",
+    "@backstage/plugin-techdocs-react": "^0.1.0",
     "@backstage/theme": "^0.2.15",
     "@material-ui/core": "^4.9.13",
     "@material-ui/icons": "^4.9.1",
@@ -51,10 +51,10 @@
     "react": "^16.13.1 || ^17.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.17.0-next.3",
-    "@backstage/core-app-api": "^1.0.1-next.1",
-    "@backstage/dev-utils": "^1.0.1-next.1",
-    "@backstage/test-utils": "^1.0.1-next.2",
+    "@backstage/cli": "^0.17.0",
+    "@backstage/core-app-api": "^1.0.1",
+    "@backstage/dev-utils": "^1.0.1",
+    "@backstage/test-utils": "^1.0.1",
     "@testing-library/jest-dom": "^5.10.1",
     "@testing-library/react": "^12.1.3",
     "@testing-library/user-event": "^14.0.0",

From a558ca830836fc2e0805bc2ab5471b5c662291f4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Wed, 20 Apr 2022 13:43:47 +0200
Subject: [PATCH 09/14] renamed package as module
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Otto Sichert <git@ottosichert.de>
Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 .changeset/techdocs-quick-owls-smile.md                     | 2 +-
 packages/app/package.json                                   | 2 +-
 packages/app/src/App.tsx                                    | 2 +-
 packages/techdocs-cli-embedded-app/package.json             | 2 +-
 .../.eslintrc.js                                            | 0
 .../api-report.md                                           | 0
 .../package.json                                            | 6 +++---
 .../src/ReportIssue/IssueLink.test.tsx                      | 0
 .../src/ReportIssue/IssueLink.tsx                           | 0
 .../src/ReportIssue/ReportIssue.tsx                         | 0
 .../src/ReportIssue/constants.ts                            | 0
 .../src/ReportIssue/hooks.ts                                | 0
 .../src/ReportIssue/index.ts                                | 0
 .../src/ReportIssue/types.ts                                | 0
 .../src/index.ts                                            | 2 +-
 .../src/plugin.test.ts                                      | 4 ++--
 .../src/plugin.ts                                           | 6 +++---
 .../src/setupTests.ts                                       | 0
 18 files changed, 13 insertions(+), 13 deletions(-)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/.eslintrc.js (100%)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/api-report.md (100%)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/package.json (91%)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/src/ReportIssue/IssueLink.test.tsx (100%)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/src/ReportIssue/IssueLink.tsx (100%)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/src/ReportIssue/ReportIssue.tsx (100%)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/src/ReportIssue/constants.ts (100%)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/src/ReportIssue/hooks.ts (100%)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/src/ReportIssue/index.ts (100%)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/src/ReportIssue/types.ts (100%)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/src/index.ts (91%)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/src/plugin.test.ts (85%)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/src/plugin.ts (87%)
 rename plugins/{techdocs-addons-contrib => techdocs-module-addons-contrib}/src/setupTests.ts (100%)

diff --git a/.changeset/techdocs-quick-owls-smile.md b/.changeset/techdocs-quick-owls-smile.md
index 7513e836ce..db4202fb5b 100644
--- a/.changeset/techdocs-quick-owls-smile.md
+++ b/.changeset/techdocs-quick-owls-smile.md
@@ -1,5 +1,5 @@
 ---
-'@backstage/plugin-techdocs-addons-contrib': minor
+'@backstage/plugin-techdocs-module-addons-contrib': minor
 ---
 
 A package for contributed TechDocs addons.
diff --git a/packages/app/package.json b/packages/app/package.json
index 708e7f247f..efe8935cd5 100644
--- a/packages/app/package.json
+++ b/packages/app/package.json
@@ -56,7 +56,7 @@
     "@backstage/plugin-tech-radar": "^0.5.11",
     "@backstage/plugin-techdocs": "^1.1.0",
     "@backstage/plugin-techdocs-react": "^0.1.0",
-    "@backstage/plugin-techdocs-addons-contrib": "^0.0.0",
+    "@backstage/plugin-techdocs-module-addons-contrib": "^0.0.0",
     "@backstage/plugin-todo": "^0.2.6",
     "@backstage/plugin-user-settings": "^0.4.3",
     "@backstage/plugin-tech-insights": "^0.2.0",
diff --git a/packages/app/src/App.tsx b/packages/app/src/App.tsx
index 9f2f190e60..4cf2c02e55 100644
--- a/packages/app/src/App.tsx
+++ b/packages/app/src/App.tsx
@@ -70,7 +70,7 @@ import {
   techdocsPlugin,
 } from '@backstage/plugin-techdocs';
 import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
-import { ReportIssue } from '@backstage/plugin-techdocs-addons-contrib';
+import { ReportIssue } from '@backstage/plugin-techdocs-module-addons-contrib';
 import {
   UserSettingsPage,
   UserSettingsTab,
diff --git a/packages/techdocs-cli-embedded-app/package.json b/packages/techdocs-cli-embedded-app/package.json
index b9fced8583..3824af4e7b 100644
--- a/packages/techdocs-cli-embedded-app/package.json
+++ b/packages/techdocs-cli-embedded-app/package.json
@@ -18,7 +18,7 @@
     "@backstage/plugin-catalog": "^1.1.0",
     "@backstage/plugin-techdocs": "^1.1.0",
     "@backstage/plugin-techdocs-react": "^0.1.0",
-    "@backstage/plugin-techdocs-addons-contrib": "^0.0.0",
+    "@backstage/plugin-techdocs-module-addons-contrib": "^0.0.0",
     "@backstage/test-utils": "^1.0.1",
     "@backstage/theme": "^0.2.15",
     "@material-ui/core": "^4.11.0",
diff --git a/plugins/techdocs-addons-contrib/.eslintrc.js b/plugins/techdocs-module-addons-contrib/.eslintrc.js
similarity index 100%
rename from plugins/techdocs-addons-contrib/.eslintrc.js
rename to plugins/techdocs-module-addons-contrib/.eslintrc.js
diff --git a/plugins/techdocs-addons-contrib/api-report.md b/plugins/techdocs-module-addons-contrib/api-report.md
similarity index 100%
rename from plugins/techdocs-addons-contrib/api-report.md
rename to plugins/techdocs-module-addons-contrib/api-report.md
diff --git a/plugins/techdocs-addons-contrib/package.json b/plugins/techdocs-module-addons-contrib/package.json
similarity index 91%
rename from plugins/techdocs-addons-contrib/package.json
rename to plugins/techdocs-module-addons-contrib/package.json
index a2f25f9607..cff78620b0 100644
--- a/plugins/techdocs-addons-contrib/package.json
+++ b/plugins/techdocs-module-addons-contrib/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "@backstage/plugin-techdocs-addons-contrib",
-  "description": "Plugin for contributed TechDocs Addons",
+  "name": "@backstage/plugin-techdocs-module-addons-contrib",
+  "description": "Plugin module for contributed TechDocs Addons",
   "version": "0.0.0",
   "main": "src/index.ts",
   "types": "src/index.ts",
@@ -12,7 +12,7 @@
     "types": "dist/index.d.ts"
   },
   "backstage": {
-    "role": "frontend-plugin"
+    "role": "frontend-plugin-module"
   },
   "homepage": "https://backstage.io",
   "repository": {
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/IssueLink.test.tsx b/plugins/techdocs-module-addons-contrib/src/ReportIssue/IssueLink.test.tsx
similarity index 100%
rename from plugins/techdocs-addons-contrib/src/ReportIssue/IssueLink.test.tsx
rename to plugins/techdocs-module-addons-contrib/src/ReportIssue/IssueLink.test.tsx
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/IssueLink.tsx b/plugins/techdocs-module-addons-contrib/src/ReportIssue/IssueLink.tsx
similarity index 100%
rename from plugins/techdocs-addons-contrib/src/ReportIssue/IssueLink.tsx
rename to plugins/techdocs-module-addons-contrib/src/ReportIssue/IssueLink.tsx
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/ReportIssue.tsx b/plugins/techdocs-module-addons-contrib/src/ReportIssue/ReportIssue.tsx
similarity index 100%
rename from plugins/techdocs-addons-contrib/src/ReportIssue/ReportIssue.tsx
rename to plugins/techdocs-module-addons-contrib/src/ReportIssue/ReportIssue.tsx
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/constants.ts b/plugins/techdocs-module-addons-contrib/src/ReportIssue/constants.ts
similarity index 100%
rename from plugins/techdocs-addons-contrib/src/ReportIssue/constants.ts
rename to plugins/techdocs-module-addons-contrib/src/ReportIssue/constants.ts
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/hooks.ts b/plugins/techdocs-module-addons-contrib/src/ReportIssue/hooks.ts
similarity index 100%
rename from plugins/techdocs-addons-contrib/src/ReportIssue/hooks.ts
rename to plugins/techdocs-module-addons-contrib/src/ReportIssue/hooks.ts
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/index.ts b/plugins/techdocs-module-addons-contrib/src/ReportIssue/index.ts
similarity index 100%
rename from plugins/techdocs-addons-contrib/src/ReportIssue/index.ts
rename to plugins/techdocs-module-addons-contrib/src/ReportIssue/index.ts
diff --git a/plugins/techdocs-addons-contrib/src/ReportIssue/types.ts b/plugins/techdocs-module-addons-contrib/src/ReportIssue/types.ts
similarity index 100%
rename from plugins/techdocs-addons-contrib/src/ReportIssue/types.ts
rename to plugins/techdocs-module-addons-contrib/src/ReportIssue/types.ts
diff --git a/plugins/techdocs-addons-contrib/src/index.ts b/plugins/techdocs-module-addons-contrib/src/index.ts
similarity index 91%
rename from plugins/techdocs-addons-contrib/src/index.ts
rename to plugins/techdocs-module-addons-contrib/src/index.ts
index ed89ba976b..09fe1f8671 100644
--- a/plugins/techdocs-addons-contrib/src/index.ts
+++ b/plugins/techdocs-module-addons-contrib/src/index.ts
@@ -20,7 +20,7 @@
  * @packageDocumentation
  */
 
-export { techdocsAddonsContribPlugin, ReportIssue } from './plugin';
+export { techdocsModuleAddonsContribPlugin, ReportIssue } from './plugin';
 export type {
   ReportIssueProps,
   ReportIssueTemplate,
diff --git a/plugins/techdocs-addons-contrib/src/plugin.test.ts b/plugins/techdocs-module-addons-contrib/src/plugin.test.ts
similarity index 85%
rename from plugins/techdocs-addons-contrib/src/plugin.test.ts
rename to plugins/techdocs-module-addons-contrib/src/plugin.test.ts
index 071623fc4f..249cea6624 100644
--- a/plugins/techdocs-addons-contrib/src/plugin.test.ts
+++ b/plugins/techdocs-module-addons-contrib/src/plugin.test.ts
@@ -13,10 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { techdocsAddonsContribPlugin } from './plugin';
+import { techdocsModuleAddonsContribPlugin } from './plugin';
 
 describe('techdocs-addons-contrib', () => {
   it('should export plugin', () => {
-    expect(techdocsAddonsContribPlugin).toBeDefined();
+    expect(techdocsModuleAddonsContribPlugin).toBeDefined();
   });
 });
diff --git a/plugins/techdocs-addons-contrib/src/plugin.ts b/plugins/techdocs-module-addons-contrib/src/plugin.ts
similarity index 87%
rename from plugins/techdocs-addons-contrib/src/plugin.ts
rename to plugins/techdocs-module-addons-contrib/src/plugin.ts
index f29d6ed5dd..e71ec2a5c7 100644
--- a/plugins/techdocs-addons-contrib/src/plugin.ts
+++ b/plugins/techdocs-module-addons-contrib/src/plugin.ts
@@ -27,8 +27,8 @@ import { ReportIssueAddon, ReportIssueProps } from './ReportIssue';
  * @public
  */
 
-export const techdocsAddonsContribPlugin = createPlugin({
-  id: 'techdocsAddonsContrib',
+export const techdocsModuleAddonsContribPlugin = createPlugin({
+  id: 'techdocsModuleAddonsContrib',
 });
 
 /**
@@ -37,7 +37,7 @@ export const techdocsAddonsContribPlugin = createPlugin({
  * @public
  */
 
-export const ReportIssue = techdocsAddonsContribPlugin.provide(
+export const ReportIssue = techdocsModuleAddonsContribPlugin.provide(
   createTechDocsAddonExtension<ReportIssueProps>({
     name: 'ReportIssue',
     location: TechDocsAddonLocations.Content,
diff --git a/plugins/techdocs-addons-contrib/src/setupTests.ts b/plugins/techdocs-module-addons-contrib/src/setupTests.ts
similarity index 100%
rename from plugins/techdocs-addons-contrib/src/setupTests.ts
rename to plugins/techdocs-module-addons-contrib/src/setupTests.ts

From 80bad5cf7364b09b235acd8d1ac35bd2db2986c6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Wed, 20 Apr 2022 13:54:27 +0200
Subject: [PATCH 10/14] log error if not github or gitlab
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Otto Sichert <git@ottosichert.de>
Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 .../src/ReportIssue/hooks.ts                              | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/plugins/techdocs-module-addons-contrib/src/ReportIssue/hooks.ts b/plugins/techdocs-module-addons-contrib/src/ReportIssue/hooks.ts
index a124f2978f..19cb47ec40 100644
--- a/plugins/techdocs-module-addons-contrib/src/ReportIssue/hooks.ts
+++ b/plugins/techdocs-module-addons-contrib/src/ReportIssue/hooks.ts
@@ -32,8 +32,14 @@ import { PAGE_EDIT_LINK_SELECTOR } from './constants';
 const resolveBlobUrl = (url: string, type: string) => {
   if (type === 'github') {
     return replaceGitHubUrlType(url, 'blob');
+  } else if (type === 'gitlab') {
+    return replaceGitLabUrlType(url, 'blob');
   }
-  return replaceGitLabUrlType(url, 'blob');
+  // eslint-disable-next-line no-console
+  console.error(
+    `Invalid SCM type ${type} found in ReportIssue addon for URL ${url}!`,
+  );
+  return url;
 };
 
 export const getTitle = (selection: Selection) => {

From c3944d2838331cc65fdeb0be5f6080df6bbab18c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Wed, 20 Apr 2022 14:51:19 +0200
Subject: [PATCH 11/14] remove addon from techdocs-cli-embedded-app
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 packages/techdocs-cli-embedded-app/package.json | 1 -
 packages/techdocs-cli-embedded-app/src/App.tsx  | 2 --
 2 files changed, 3 deletions(-)

diff --git a/packages/techdocs-cli-embedded-app/package.json b/packages/techdocs-cli-embedded-app/package.json
index 3824af4e7b..b438a8d7f9 100644
--- a/packages/techdocs-cli-embedded-app/package.json
+++ b/packages/techdocs-cli-embedded-app/package.json
@@ -18,7 +18,6 @@
     "@backstage/plugin-catalog": "^1.1.0",
     "@backstage/plugin-techdocs": "^1.1.0",
     "@backstage/plugin-techdocs-react": "^0.1.0",
-    "@backstage/plugin-techdocs-module-addons-contrib": "^0.0.0",
     "@backstage/test-utils": "^1.0.1",
     "@backstage/theme": "^0.2.15",
     "@material-ui/core": "^4.11.0",
diff --git a/packages/techdocs-cli-embedded-app/src/App.tsx b/packages/techdocs-cli-embedded-app/src/App.tsx
index 4596ff70e7..194d26943d 100644
--- a/packages/techdocs-cli-embedded-app/src/App.tsx
+++ b/packages/techdocs-cli-embedded-app/src/App.tsx
@@ -28,7 +28,6 @@ import {
   TechDocsAddons,
   TechDocsAddonLocations,
 } from '@backstage/plugin-techdocs-react';
-import { ReportIssue } from '@backstage/plugin-techdocs-addons-contrib';
 import { createApp } from '@backstage/app-defaults';
 import { FlatRoutes } from '@backstage/core-app-api';
 import { CatalogEntityPage } from '@backstage/plugin-catalog';
@@ -73,7 +72,6 @@ const routes = (
     >
       {techDocsPage}
       <TechDocsAddons>
-        <ReportIssue />
         <ThemeToggleAddon />
       </TechDocsAddons>
     </Route>

From 2d14cbee021798fa50c02316d0d76bf9e96f4bbb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Thu, 21 Apr 2022 08:32:23 +0200
Subject: [PATCH 12/14] update api-report
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 plugins/techdocs-module-addons-contrib/api-report.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/plugins/techdocs-module-addons-contrib/api-report.md b/plugins/techdocs-module-addons-contrib/api-report.md
index b02521f2e3..1929bf69d5 100644
--- a/plugins/techdocs-module-addons-contrib/api-report.md
+++ b/plugins/techdocs-module-addons-contrib/api-report.md
@@ -1,4 +1,4 @@
-## API Report File for "@backstage/plugin-techdocs-addons-contrib"
+## API Report File for "@backstage/plugin-techdocs-module-addons-contrib"
 
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
@@ -29,5 +29,5 @@ export type ReportIssueTemplateBuilder = (
 ) => ReportIssueTemplate;
 
 // @public
-export const techdocsAddonsContribPlugin: BackstagePlugin<{}, {}>;
+export const techdocsModuleAddonsContribPlugin: BackstagePlugin<{}, {}>;
 ```

From aae62d0d12137a9b9d2a56bba886edfbea2f348b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Thu, 21 Apr 2022 14:52:18 +0200
Subject: [PATCH 13/14] review feedback
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 plugins/techdocs-module-addons-contrib/package.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/plugins/techdocs-module-addons-contrib/package.json b/plugins/techdocs-module-addons-contrib/package.json
index cff78620b0..c9695c40e2 100644
--- a/plugins/techdocs-module-addons-contrib/package.json
+++ b/plugins/techdocs-module-addons-contrib/package.json
@@ -18,7 +18,7 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/backstage/backstage",
-    "directory": "plugins/techdocs-addons-contrib"
+    "directory": "plugins/techdocs-module-addons-contrib"
   },
   "keywords": [
     "backstage",

From 1107e90adb5e74d82549d7e2f877c6a5fa532e0b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Anders=20N=C3=A4sman?= <andersn@spotify.com>
Date: Mon, 25 Apr 2022 14:45:13 +0200
Subject: [PATCH 14/14] wrap selection in object
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Camila Belo <camilaibs@gmail.com>
Co-authored-by: Eric Peterson <iamEAP@users.noreply.github.com>
Signed-off-by: Anders Näsman <andersn@spotify.com>
---
 plugins/techdocs-module-addons-contrib/api-report.md      | 8 +++++---
 .../src/ReportIssue/ReportIssue.tsx                       | 4 +++-
 .../src/ReportIssue/types.ts                              | 8 +++++---
 3 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/plugins/techdocs-module-addons-contrib/api-report.md b/plugins/techdocs-module-addons-contrib/api-report.md
index 1929bf69d5..264f12970b 100644
--- a/plugins/techdocs-module-addons-contrib/api-report.md
+++ b/plugins/techdocs-module-addons-contrib/api-report.md
@@ -24,9 +24,11 @@ export type ReportIssueTemplate = {
 };
 
 // @public (undocumented)
-export type ReportIssueTemplateBuilder = (
-  selection: Selection,
-) => ReportIssueTemplate;
+export type ReportIssueTemplateBuilder = ({
+  selection,
+}: {
+  selection: Selection;
+}) => ReportIssueTemplate;
 
 // @public
 export const techdocsModuleAddonsContribPlugin: BackstagePlugin<{}, {}>;
diff --git a/plugins/techdocs-module-addons-contrib/src/ReportIssue/ReportIssue.tsx b/plugins/techdocs-module-addons-contrib/src/ReportIssue/ReportIssue.tsx
index 21f0317b3a..2fe8d604e6 100644
--- a/plugins/techdocs-module-addons-contrib/src/ReportIssue/ReportIssue.tsx
+++ b/plugins/techdocs-module-addons-contrib/src/ReportIssue/ReportIssue.tsx
@@ -124,7 +124,9 @@ export const ReportIssueAddon = ({
       >
         <IssueLink
           repository={repository}
-          template={buildTemplate ? buildTemplate(selection) : defaultTemplate}
+          template={
+            buildTemplate ? buildTemplate({ selection }) : defaultTemplate
+          }
         />
       </Paper>
     </Portal>
diff --git a/plugins/techdocs-module-addons-contrib/src/ReportIssue/types.ts b/plugins/techdocs-module-addons-contrib/src/ReportIssue/types.ts
index 94d1107822..a4780535ca 100644
--- a/plugins/techdocs-module-addons-contrib/src/ReportIssue/types.ts
+++ b/plugins/techdocs-module-addons-contrib/src/ReportIssue/types.ts
@@ -25,9 +25,11 @@ export type ReportIssueTemplate = {
 /**
  * @public
  */
-export type ReportIssueTemplateBuilder = (
-  selection: Selection,
-) => ReportIssueTemplate;
+export type ReportIssueTemplateBuilder = ({
+  selection,
+}: {
+  selection: Selection;
+}) => ReportIssueTemplate;
 
 export type Repository = {
   type: string;