[Doc Improvement][Adaptive Card website banner][4314613] #12473
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
There was a problem hiding this comment.
Pull Request Overview
This PR improves documentation by adding a redirection banner for Adaptive Cards legacy documentation to guide users toward the new Adaptive Cards documentation hub.
- Introduces an include snippet for the legacy redirect in multiple Adaptive Cards documentation files.
- Ensures that readers are informed about the updated documentation location consistently across the site.
Reviewed Changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| msteams-platform/includes/adaptive-card-redirect.md | Adds a legacy alert and redirection to the new Adaptive Cards documentation hub. |
| msteams-platform/task-modules-and-cards/cards/cards-reference.md | Inserts the adaptive card redirect include before Adaptive Card description. |
| msteams-platform/task-modules-and-cards/what-are-cards.md | Inserts the adaptive card redirect include at the beginning of the Adaptive Cards section. |
| msteams-platform/task-modules-and-cards/cards/cards-actions.md | Inserts the adaptive card redirect include to guide users towards updated guidance. |
| msteams-platform/task-modules-and-cards/cards/cards-format.md | Inserts the adaptive card redirect include for updated information routing. |
| msteams-platform/task-modules-and-cards/cards/Universal-actions-for-adaptive-cards/Overview.md | Inserts the adaptive card redirect include for universal actions guidance. |
| msteams-platform/task-modules-and-cards/cards/Universal-actions-for-adaptive-cards/Work-with-Universal-Actions-for-Adaptive-Cards.md | Inserts the adaptive card redirect include for universal actions guidance. |
| msteams-platform/task-modules-and-cards/cards/Universal-actions-for-adaptive-cards/authentication-flow-in-universal-action-for-adaptive-cards.md | Inserts the adaptive card redirect include for authentication flow context. |
| msteams-platform/task-modules-and-cards/cards/Universal-actions-for-adaptive-cards/sso-adaptive-cards-universal-action.md | Inserts the adaptive card redirect include for SSO guidance. |
| msteams-platform/task-modules-and-cards/container-layouts.md | Inserts the adaptive card redirect include for container layout documentation. |
| msteams-platform/task-modules-and-cards/cards/charts-in-adaptive-cards.md | Inserts the adaptive card redirect include for chart guidance in Adaptive Cards. |
| msteams-platform/task-modules-and-cards/cards/design-effective-cards.md | Inserts the adaptive card redirect include for design guidance consistency. |
| msteams-platform/task-modules-and-cards/cards/Universal-actions-for-adaptive-cards/Sequential-Workflows.md | Inserts the adaptive card redirect include for sequential workflows. |
| msteams-platform/task-modules-and-cards/cards/Universal-actions-for-adaptive-cards/enable-sso-for-your-adaptive-cards-universal-action.md | Inserts the adaptive card redirect include to guide SSO documentation. |
| msteams-platform/task-modules-and-cards/cards/Universal-actions-for-adaptive-cards/Up-To-Date-Views.md | Inserts the adaptive card redirect include for the latest Adaptive Cards information. |
| msteams-platform/task-modules-and-cards/cards/dynamic-search.md | Inserts the adaptive card redirect include for typeahead search explanation. |
| msteams-platform/task-modules-and-cards/cards/people-picker.md | Inserts the adaptive card redirect include for People Picker documentation. |
| msteams-platform/task-modules-and-cards/cards/Universal-actions-for-adaptive-cards/User-Specific-Views.md | Inserts the adaptive card redirect include for user-specific views clarification. |
| msteams-platform/task-modules-and-cards/cards/media-elements-in-adaptive-cards.md | Inserts the adaptive card redirect include for media elements guidance. |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
| @@ -8,6 +8,8 @@ ms.date: 02/28/2023 | |||
|
|
|||
| # Universal Actions for Adaptive Cards | |||
|
|
|||
| [!INCLUDE [adaptive-card-redirect](../../../includes/adaptive-card-redirect.md)] | |||
There was a problem hiding this comment.
This file is actually an example of where we should - at least for now - not redirect. https://adaptivecards.microsoft.com itself links into MSLearn for universal actions.
So let's keep this page and all pages that are about the "universal action model" untouched for now (I'm not adding that same comment to all of them)
There was a problem hiding this comment.
I've removed the redirects, @dclaux.
| @@ -10,6 +10,8 @@ ms.date: 11/07/2024 | |||
|
|
|||
| # Container layouts | |||
|
|
|||
| [!INCLUDE [adaptive-card-redirect](../includes/adaptive-card-redirect.md)] | |||
|
|
|||
There was a problem hiding this comment.
So the banner is great, but it would be better if the link to https://adaptivecards.microsoft.com pointed to the right page. Here, we're talking about https://adaptivecards.microsoft.com/?topic=container-layouts
There was a problem hiding this comment.
I've updated the link, @dclaux. However, I'd like to point out that the reasons I initially decided not to link to each feature's individual page is because it runs the risk of causing a broken link if the page/website's link is updated/modified in the future (I'm not adding that same comment for all the instances where we are linking to individual feature pages, but it applies nonetheless).
There was a problem hiding this comment.
I think there is an implicit commitment that we won't break links - people might bookmark these, and we can't just remove things under them.
Looks good
| @@ -10,6 +10,8 @@ ms.date: 02/26/2025 | |||
|
|
|||
| # People Picker in Adaptive Cards | |||
|
|
|||
| [!INCLUDE [adaptive-card-redirect](../../includes/adaptive-card-redirect.md)] | |||
|
|
|||
There was a problem hiding this comment.
Should link to https://adaptivecards.microsoft.com/?topic=people-picker rather than the welcome page
There was a problem hiding this comment.
I've updated the link, @dclaux.
| @@ -9,6 +9,8 @@ ms.date: 02/26/2025 | |||
|
|
|||
| # Media elements in Adaptive Card | |||
|
|
|||
| [!INCLUDE [adaptive-card-redirect](../../includes/adaptive-card-redirect.md)] | |||
|
|
|||
There was a problem hiding this comment.
Should link to https://adaptivecards.microsoft.com/?topic=Media
There was a problem hiding this comment.
I've updated the link, @dclaux.
| @@ -10,6 +10,8 @@ ms.date: 01/23/2025 | |||
|
|
|||
| # Typeahead search in Adaptive Cards | |||
|
|
|||
| [!INCLUDE [adaptive-card-redirect](../../includes/adaptive-card-redirect.md)] | |||
|
|
|||
There was a problem hiding this comment.
Should link to https://adaptivecards.microsoft.com/?topic=dynamic-typeahead
There was a problem hiding this comment.
I've updated the link, @dclaux.
| @@ -8,6 +8,8 @@ ms.date: 11/07/2024 | |||
|
|
|||
| # Charts in Adaptive Cards | |||
|
|
|||
| [!INCLUDE [adaptive-card-redirect](../../includes/adaptive-card-redirect.md)] | |||
|
|
|||
There was a problem hiding this comment.
Should have links to these pages:
- https://adaptivecards.microsoft.com/?topic=Chart.Donut
- https://adaptivecards.microsoft.com/?topic=Chart.Gauge
- https://adaptivecards.microsoft.com/?topic=Chart.HorizontalBar
- https://adaptivecards.microsoft.com/?topic=Chart.HorizontalBar.Stacked
- https://adaptivecards.microsoft.com/?topic=Chart.Line
- https://adaptivecards.microsoft.com/?topic=Chart.Pie
- https://adaptivecards.microsoft.com/?topic=Chart.VerticalBar
- https://adaptivecards.microsoft.com/?topic=Chart.VerticalBar.Grouped
There was a problem hiding this comment.
I've added the links in the introductory paragraph and not in the banner, @dclaux. When I tried adding the links to the banner, because of the sheer number of links, it seemed bloated and hard to follow.
| @@ -8,6 +8,8 @@ ms.date: 09/16/2024 | |||
|
|
|||
| # Types of cards | |||
|
|
|||
| [!INCLUDE [adaptive-card-redirect](../../includes/adaptive-card-redirect.md)] | |||
There was a problem hiding this comment.
This doesn't work here. This page is about more than just Adaptive Cards. We need to link to the new site only in places on this page that are about Adaptive Cards (for example, here: https://github.com/MicrosoftDocs/msteams-docs/blob/8651a281285c123726649148408ebddd60fd6c2b/msteams-platform/task-modules-and-cards/cards/cards-reference.md#adaptive-card)
There was a problem hiding this comment.
I've moved the banner to Adaptive Card, @dclaux. My intention of keeping the banner at the top was to nudge developers away from designing regular cards and encourage them to visit the new website and adopt Adaptive Cards.
| @@ -8,6 +8,8 @@ ms.date: 11/07/2024 | |||
|
|
|||
| # Format cards in Teams | |||
|
|
|||
| [!INCLUDE [adaptive-card-redirect](../../includes/adaptive-card-redirect.md)] | |||
There was a problem hiding this comment.
I don't think this works here. This page is about more than Adaptive Cards. The banner should go under the "Markdown format for Adaptive Cards" title, and it should link to https://adaptivecards.microsoft.com/?topic=TextBlock
There was a problem hiding this comment.
I've updated the banner, @dclaux. Just like the previous instance, I kept the banner at the top was to nudge developers away from designing regular cards and encourage them to visit the new website and adopt Adaptive Cards.
| @@ -8,6 +8,8 @@ ms.date: 11/07/2024 | |||
|
|
|||
| # Card actions | |||
|
|
|||
| [!INCLUDE [adaptive-card-redirect](../../includes/adaptive-card-redirect.md)] | |||
There was a problem hiding this comment.
The banner doesn't work on this page which is about more than just Adaptive Cards. We already have links to the new site need to be under the "Adaptive Card actions" title, so that might be enough. But we could consider adding the banner under that title as well, maybe a short version of it without the image.
There was a problem hiding this comment.
Agreed, @dclaux. I've moved the banner to Adaptive Card actions, @dclaux.
| @@ -9,6 +9,8 @@ ms.date: 02/06/2023 | |||
|
|
|||
| # Add code to enable SSO for Adaptive Cards Universal Actions | |||
|
|
|||
| [!INCLUDE [adaptive-card-redirect](../../../includes/adaptive-card-redirect.md)] | |||
There was a problem hiding this comment.
This page isn't about Adaptive Cards per se and is valuable to developers. Let's not put the banner here.
There was a problem hiding this comment.
Removed, @dclaux.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
v-kushals
dismissed stale reviews from v-srmurugan and ChetanSharma-msft
via
7f957b9
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
Learn Build status updates of commit 3fe293b: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit e2c40c1: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
No description provided.