From 64635315745da601e8a7c6fbc156351ad8c96bae Mon Sep 17 00:00:00 2001 From: BrunoQuaresma Date: Fri, 2 Feb 2024 13:57:45 +0000 Subject: [PATCH 1/3] feat(site): show deprecation message on template page --- .../TemplatePageHeader.stories.tsx | 10 +++++++ .../pages/TemplatePage/TemplatePageHeader.tsx | 27 ++++++++++++------- 2 files changed, 27 insertions(+), 10 deletions(-) diff --git a/site/src/pages/TemplatePage/TemplatePageHeader.stories.tsx b/site/src/pages/TemplatePage/TemplatePageHeader.stories.tsx index e5e837145ae06..d13d23a1be364 100644 --- a/site/src/pages/TemplatePage/TemplatePageHeader.stories.tsx +++ b/site/src/pages/TemplatePage/TemplatePageHeader.stories.tsx @@ -26,3 +26,13 @@ export const CanNotUpdate: Story = { }, }, }; + +export const Deprecated: Story = { + args: { + template: { + ...MockTemplate, + deprecated: true, + deprecation_message: "This template is not going to be used anymore.", + }, + }, +}; diff --git a/site/src/pages/TemplatePage/TemplatePageHeader.tsx b/site/src/pages/TemplatePage/TemplatePageHeader.tsx index 90515523e1af2..ba4a43e5d9863 100644 --- a/site/src/pages/TemplatePage/TemplatePageHeader.tsx +++ b/site/src/pages/TemplatePage/TemplatePageHeader.tsx @@ -203,20 +203,27 @@ export const TemplatePageHeader: FC = ({ )}
- - {template.display_name.length > 0 - ? template.display_name - : template.name} - - - {template.description !== "" && ( + + + {template.display_name.length > 0 + ? template.display_name + : template.name} + + {template.deprecated && Deprecated} + + + {template.deprecation_message !== "" ? ( - {template.description} + {template.deprecation_message} + ) : ( + template.description !== "" && ( + + {template.description} + + ) )}
- - {template.deprecated && Deprecated} From 5642ef1feadb68884a96b20de90919480d1cfa04 Mon Sep 17 00:00:00 2001 From: BrunoQuaresma Date: Fri, 2 Feb 2024 13:59:53 +0000 Subject: [PATCH 2/3] Use markdown --- site/src/pages/TemplatePage/TemplatePageHeader.tsx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/site/src/pages/TemplatePage/TemplatePageHeader.tsx b/site/src/pages/TemplatePage/TemplatePageHeader.tsx index ba4a43e5d9863..cfa686d93d4df 100644 --- a/site/src/pages/TemplatePage/TemplatePageHeader.tsx +++ b/site/src/pages/TemplatePage/TemplatePageHeader.tsx @@ -35,6 +35,7 @@ import { } from "components/MoreMenu/MoreMenu"; import Divider from "@mui/material/Divider"; import { Pill } from "components/Pill/Pill"; +import { MemoizedInlineMarkdown } from "components/Markdown/Markdown"; type TemplateMenuProps = { templateName: string; @@ -214,7 +215,9 @@ export const TemplatePageHeader: FC = ({ {template.deprecation_message !== "" ? ( - {template.deprecation_message} + + {template.deprecation_message} + ) : ( template.description !== "" && ( From 6bb078f74b5d97ce39c5796ffd890897c6fbf52c Mon Sep 17 00:00:00 2001 From: BrunoQuaresma Date: Fri, 2 Feb 2024 14:07:53 +0000 Subject: [PATCH 3/3] Add test for markdown --- site/src/pages/TemplatePage/TemplatePageHeader.stories.tsx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/site/src/pages/TemplatePage/TemplatePageHeader.stories.tsx b/site/src/pages/TemplatePage/TemplatePageHeader.stories.tsx index d13d23a1be364..7def82b032720 100644 --- a/site/src/pages/TemplatePage/TemplatePageHeader.stories.tsx +++ b/site/src/pages/TemplatePage/TemplatePageHeader.stories.tsx @@ -32,7 +32,8 @@ export const Deprecated: Story = { template: { ...MockTemplate, deprecated: true, - deprecation_message: "This template is not going to be used anymore.", + deprecation_message: + "This template is not going to be used anymore. [See details](#details).", }, }, };