diff --git a/cypress/fixtures/mkdocs.yml b/cypress/fixtures/mkdocs.yml index 2362fab898..071d147509 100644 --- a/cypress/fixtures/mkdocs.yml +++ b/cypress/fixtures/mkdocs.yml @@ -1,5 +1,8 @@ site_name: e2e Fixture Documentation site_description: Documentation used for end-to-end tests of TechDocs in Backstage. +repo_url: https://github.com/backstage/backstage +edit_uri: edit/master/cypress/fixtures/docs + nav: - Home: index.md - Sub-page 1: sub-page-one.md diff --git a/mkdocs.yml b/mkdocs.yml index 204a4768c3..5c73516ba6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,7 @@ site_name: 'Backstage' site_description: 'Main documentation for Backstage features and platform APIs' +repo_url: https://github.com/backstage/backstage +edit_uri: edit/master/docs plugins: - techdocs-core diff --git a/packages/app/src/App.tsx b/packages/app/src/App.tsx index 51012b042a..6a2fb7e0f6 100644 --- a/packages/app/src/App.tsx +++ b/packages/app/src/App.tsx @@ -68,6 +68,7 @@ import { TechDocsIndexPage, TechDocsReaderPage, techdocsPlugin, + GiveFeedbackAddon, } from '@backstage/plugin-techdocs'; import { UserSettingsPage, @@ -93,13 +94,6 @@ import { techDocsPage } from './components/techdocs/TechDocsPage'; import { ApacheAirflowPage } from '@backstage/plugin-apache-airflow'; import { PermissionedRoute } from '@backstage/plugin-permission-react'; import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common'; -import { - ExampleContent, - ExampleHeader, - ExamplePrimarySidebar, - ExampleSecondarySidebar, - ExampleSubHeader, -} from './components/techdocs/ExampleAddons'; const app = createApp({ apis, @@ -188,11 +182,7 @@ const routes = ( > {techDocsPage} - - - - - + - - - - - + @@ -482,11 +474,7 @@ const websiteEntityPage = ( - - - - - + @@ -529,11 +517,7 @@ const defaultEntityPage = ( - - - - - + diff --git a/packages/app/src/components/techdocs/ExampleAddons.tsx b/packages/app/src/components/techdocs/ExampleAddons.tsx deleted file mode 100644 index 7b5fdba80c..0000000000 --- a/packages/app/src/components/techdocs/ExampleAddons.tsx +++ /dev/null @@ -1,108 +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, { useEffect } from 'react'; - -import { Card, CardContent } from '@material-ui/core'; - -import { - techdocsPlugin, - useShadowRootElements, -} from '@backstage/plugin-techdocs'; -import { - createTechDocsAddon, - TechDocsAddonLocations, -} from '@backstage/techdocs-addons'; -import { HeaderLabel } from '@backstage/core-components'; - -/** - * Note: this is not typically how or where one might define such things. It - * would more typically be exported/provided by a plugin! - * - * In fact, this whole file and usage should be deleted before we merge things - * in. This is just a convenient way to test the addon framework in a nice - * end-to-end way before releasing anything. - */ - -export const ExampleHeader = techdocsPlugin.provide( - createTechDocsAddon({ - name: 'ExampleHeader', - location: TechDocsAddonLocations.HEADER, - component: () => { - return ; - }, - }), -); - -export const ExampleSubHeader = techdocsPlugin.provide( - createTechDocsAddon({ - name: 'ExampleSubHeader', - location: TechDocsAddonLocations.SUBHEADER, - component: () => { - return ( - - Subheader. - - ); - }, - }), -); - -export const ExamplePrimarySidebar = techdocsPlugin.provide( - createTechDocsAddon({ - name: 'ExamplePrimarySidebar', - location: TechDocsAddonLocations.PRIMARY_SIDEBAR, - component: () => { - return ( - - Primary Sidebar. - - ); - }, - }), -); - -export const ExampleSecondarySidebar = techdocsPlugin.provide( - createTechDocsAddon({ - name: 'ExampleSecondarySidebar', - location: TechDocsAddonLocations.SECONDARY_SIDEBAR, - component: () => { - return ( - - Secondary Sidebar. - - ); - }, - }), -); - -const ExampleContentComponent = () => { - const h1 = useShadowRootElements(['h1'])[0]; - useEffect(() => { - if (h1 && !h1.innerText.startsWith('Modified: ')) { - h1.innerText = `Modified: ${h1.innerText}`; - } - }, [h1]); - return null; -}; - -export const ExampleContent = techdocsPlugin.provide( - createTechDocsAddon({ - name: 'ExampleContent', - location: TechDocsAddonLocations.CONTENT, - component: ExampleContentComponent, - }), -); diff --git a/plugins/techdocs-backend/examples/documented-component/mkdocs.yml b/plugins/techdocs-backend/examples/documented-component/mkdocs.yml index 2087979d22..1a159a4d12 100644 --- a/plugins/techdocs-backend/examples/documented-component/mkdocs.yml +++ b/plugins/techdocs-backend/examples/documented-component/mkdocs.yml @@ -1,4 +1,6 @@ site_name: 'Example Documentation' +repo_url: https://github.com/backstage/backstage +edit_uri: edit/master/plugins/techdocs-backend/examples/documented-component/docs nav: - Home: index.md