From 67bf8321f086f551d4e8a7e988e02d760a408a5e Mon Sep 17 00:00:00 2001 From: Jonathan Roebuck Date: Fri, 18 Oct 2024 11:57:33 +0100 Subject: [PATCH 1/6] add docs root index.md file with link to Backstage overview Signed-off-by: Jonathan Roebuck --- docs/index.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 docs/index.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000000..12286c9c2e --- /dev/null +++ b/docs/index.md @@ -0,0 +1,7 @@ +--- +id: docs-index +title: Backstage docs +description: Learn about Backstage, an open-source framework for building developer portals. +--- + +For an introduction to Backstage and its features, check out the [What is Backstage?](./overview/what-is-backstage.md) page. From 16a436abfc0cb91d7ac6750e4969b874ec91b419 Mon Sep 17 00:00:00 2001 From: Jonathan Roebuck Date: Tue, 22 Oct 2024 12:57:29 +0100 Subject: [PATCH 2/6] use redirect instead of docs/index.md Signed-off-by: Jonathan Roebuck --- docs/index.md | 7 ------- mkdocs.yml | 3 +++ 2 files changed, 3 insertions(+), 7 deletions(-) delete mode 100644 docs/index.md diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 12286c9c2e..0000000000 --- a/docs/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -id: docs-index -title: Backstage docs -description: Learn about Backstage, an open-source framework for building developer portals. ---- - -For an introduction to Backstage and its features, check out the [What is Backstage?](./overview/what-is-backstage.md) page. diff --git a/mkdocs.yml b/mkdocs.yml index aa545111d4..76467e9476 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,6 +5,9 @@ edit_uri: edit/master/docs plugins: - techdocs-core + - redirects: + redirect_maps: + 'index.md': 'overview/what-is-backstage.md' # For sidebar navigation on https://backstage.io/, see `microsite/sidebars.js` nav: From 2bfd20ae44d598be5e00c8c9bc15d50137f312f4 Mon Sep 17 00:00:00 2001 From: Jonathan Roebuck Date: Tue, 5 Nov 2024 10:29:13 +0000 Subject: [PATCH 3/6] fix double redirect bug Signed-off-by: Jonathan Roebuck --- .../components/TechDocsReaderPageContent/dom.tsx | 2 +- .../src/reader/transformers/handleMetaRedirects.tsx | 12 +++++------- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/plugins/techdocs/src/reader/components/TechDocsReaderPageContent/dom.tsx b/plugins/techdocs/src/reader/components/TechDocsReaderPageContent/dom.tsx index 3656d22326..901a2f56a9 100644 --- a/plugins/techdocs/src/reader/components/TechDocsReaderPageContent/dom.tsx +++ b/plugins/techdocs/src/reader/components/TechDocsReaderPageContent/dom.tsx @@ -187,7 +187,7 @@ export const useTechDocsReaderDom = ( const postRender = useCallback( async (transformedElement: Element) => transformer(transformedElement, [ - handleMetaRedirects(navigate, entityRef.name), + handleMetaRedirects(entityRef.name), scrollIntoNavigation(), copyToClipboard(theme), addLinkClickListener({ diff --git a/plugins/techdocs/src/reader/transformers/handleMetaRedirects.tsx b/plugins/techdocs/src/reader/transformers/handleMetaRedirects.tsx index 04b7b27ba2..99adbee1bd 100644 --- a/plugins/techdocs/src/reader/transformers/handleMetaRedirects.tsx +++ b/plugins/techdocs/src/reader/transformers/handleMetaRedirects.tsx @@ -20,10 +20,7 @@ import React from 'react'; import { renderReactElement } from './renderReactElement'; import { TechDocsRedirectNotification } from '../components/TechDocsRedirectNotification'; -export const handleMetaRedirects = ( - navigate: (to: string) => void, - entityName: string, -): Transformer => { +export const handleMetaRedirects = (entityName: string): Transformer => { const redirectAfterMs = 3000; const determineRedirectURL = (metaUrl: string) => { @@ -55,7 +52,6 @@ export const handleMetaRedirects = ( if (!metaContentParameters || metaContentParameters.length < 2) { return dom; } - const metaUrl = metaContentParameters[1]; const redirectURL = determineRedirectURL(metaUrl); @@ -69,7 +65,9 @@ export const handleMetaRedirects = ( renderReactElement( navigate(redirectURL)} + handleButtonClick={() => { + window.location.href = redirectURL; + }} autoHideDuration={redirectAfterMs} />, container, @@ -77,7 +75,7 @@ export const handleMetaRedirects = ( document.body.appendChild(container); setTimeout(() => { - navigate(redirectURL); + window.location.href = redirectURL; }, redirectAfterMs); return dom; From b5ee3f5d3baf53b7778f4079bda15fe3cc18d529 Mon Sep 17 00:00:00 2001 From: Jonathan Roebuck Date: Tue, 5 Nov 2024 11:43:50 +0000 Subject: [PATCH 4/6] fix test Signed-off-by: Jonathan Roebuck --- .../src/reader/transformers/handleMetaRedirects.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/techdocs/src/reader/transformers/handleMetaRedirects.test.ts b/plugins/techdocs/src/reader/transformers/handleMetaRedirects.test.ts index 0be1773846..bb1f49d14b 100644 --- a/plugins/techdocs/src/reader/transformers/handleMetaRedirects.test.ts +++ b/plugins/techdocs/src/reader/transformers/handleMetaRedirects.test.ts @@ -38,7 +38,7 @@ describe('handleMetaRedirects', () => { }); return await createTestShadowDom(html, { preTransformers: [], - postTransformers: [handleMetaRedirects(navigate, entityName)], + postTransformers: [handleMetaRedirects(entityName)], }); }; beforeEach(() => { From 85db4aec871939430f9b6b599be08f0661762254 Mon Sep 17 00:00:00 2001 From: Jonathan Roebuck Date: Wed, 6 Nov 2024 08:52:18 +0000 Subject: [PATCH 5/6] Revert "fix test" This reverts commit 4b398ae6575a3a024a125c8ae8e200fc2d50414a. Signed-off-by: Jonathan Roebuck --- .../src/reader/transformers/handleMetaRedirects.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/techdocs/src/reader/transformers/handleMetaRedirects.test.ts b/plugins/techdocs/src/reader/transformers/handleMetaRedirects.test.ts index bb1f49d14b..0be1773846 100644 --- a/plugins/techdocs/src/reader/transformers/handleMetaRedirects.test.ts +++ b/plugins/techdocs/src/reader/transformers/handleMetaRedirects.test.ts @@ -38,7 +38,7 @@ describe('handleMetaRedirects', () => { }); return await createTestShadowDom(html, { preTransformers: [], - postTransformers: [handleMetaRedirects(entityName)], + postTransformers: [handleMetaRedirects(navigate, entityName)], }); }; beforeEach(() => { From 67b04f0e0c5c13ac0c44790081b9bf011930c203 Mon Sep 17 00:00:00 2001 From: Jonathan Roebuck Date: Wed, 6 Nov 2024 08:52:27 +0000 Subject: [PATCH 6/6] Revert "fix double redirect bug" This reverts commit 5d7f3702199e268d24340e954df7c41707f15eac. Signed-off-by: Jonathan Roebuck --- .../components/TechDocsReaderPageContent/dom.tsx | 2 +- .../src/reader/transformers/handleMetaRedirects.tsx | 12 +++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/plugins/techdocs/src/reader/components/TechDocsReaderPageContent/dom.tsx b/plugins/techdocs/src/reader/components/TechDocsReaderPageContent/dom.tsx index 901a2f56a9..3656d22326 100644 --- a/plugins/techdocs/src/reader/components/TechDocsReaderPageContent/dom.tsx +++ b/plugins/techdocs/src/reader/components/TechDocsReaderPageContent/dom.tsx @@ -187,7 +187,7 @@ export const useTechDocsReaderDom = ( const postRender = useCallback( async (transformedElement: Element) => transformer(transformedElement, [ - handleMetaRedirects(entityRef.name), + handleMetaRedirects(navigate, entityRef.name), scrollIntoNavigation(), copyToClipboard(theme), addLinkClickListener({ diff --git a/plugins/techdocs/src/reader/transformers/handleMetaRedirects.tsx b/plugins/techdocs/src/reader/transformers/handleMetaRedirects.tsx index 99adbee1bd..04b7b27ba2 100644 --- a/plugins/techdocs/src/reader/transformers/handleMetaRedirects.tsx +++ b/plugins/techdocs/src/reader/transformers/handleMetaRedirects.tsx @@ -20,7 +20,10 @@ import React from 'react'; import { renderReactElement } from './renderReactElement'; import { TechDocsRedirectNotification } from '../components/TechDocsRedirectNotification'; -export const handleMetaRedirects = (entityName: string): Transformer => { +export const handleMetaRedirects = ( + navigate: (to: string) => void, + entityName: string, +): Transformer => { const redirectAfterMs = 3000; const determineRedirectURL = (metaUrl: string) => { @@ -52,6 +55,7 @@ export const handleMetaRedirects = (entityName: string): Transformer => { if (!metaContentParameters || metaContentParameters.length < 2) { return dom; } + const metaUrl = metaContentParameters[1]; const redirectURL = determineRedirectURL(metaUrl); @@ -65,9 +69,7 @@ export const handleMetaRedirects = (entityName: string): Transformer => { renderReactElement( { - window.location.href = redirectURL; - }} + handleButtonClick={() => navigate(redirectURL)} autoHideDuration={redirectAfterMs} />, container, @@ -75,7 +77,7 @@ export const handleMetaRedirects = (entityName: string): Transformer => { document.body.appendChild(container); setTimeout(() => { - window.location.href = redirectURL; + navigate(redirectURL); }, redirectAfterMs); return dom;