AdaptiveCards icon indicating copy to clipboard operation
AdaptiveCards copied to clipboard

[DRAFT] Update templating documentation

Open anna-dingler opened this issue 4 years ago • 2 comments

Updating templating documentation for the following changes:

https://github.com/microsoft/AdaptiveCards/pull/7199 https://github.com/microsoft/AdaptiveCards/pull/7209

Not ready to merge until next release.

Microsoft Reviewers: Open in CodeFlow

anna-dingler avatar Apr 15 '22 22:04 anna-dingler

Docs Build status updates of commit 76eaaab:

:warning: Validation status: warnings

File Status Preview URL Details
AdaptiveCards/templating/language.md :warning:Warning Details
AdaptiveCards/templating/sdk.md :bulb:Suggestion Details

AdaptiveCards/templating/language.md

  • Line 234, Column 72: [Warning: hard-coded-locale - See documentation] Link 'https://docs.microsoft.com/en-us/adaptive-cards/templating/language#option-c-additional-host-data-object' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
  • Line 234, Column 72: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/en-us/adaptive-cards/templating/language#option-c-additional-host-data-object' will be broken in isolated environments. Replace with a relative link.
  • Line 325, Column 28: [Suggestion: preserve-view-not-set - See documentation] Did you mean to link to a specific version? It's usually better not to specify a version, so the link always goes to the canonical version. If you really need to link to a specific version, add &preserve-view=true to the URL: /azure/bot-service/bot-builder-concept-adaptive-expressions?view=azure-bot-service-4.0. Otherwise, remove the view parameter.

AdaptiveCards/templating/sdk.md

  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
  • Line 193, Column 625: [Suggestion: preserve-view-not-set - See documentation] Did you mean to link to a specific version? It's usually better not to specify a version, so the link always goes to the canonical version. If you really need to link to a specific version, add &preserve-view=true to the URL: /azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions?view=azure-bot-service-4.0#date-and-time-functions. Otherwise, remove the view parameter.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

opbld31 avatar Apr 15 '22 22:04 opbld31

Docs Build status updates of commit 3661c5a:

:white_check_mark: Validation status: passed

File Status Preview URL Details
AdaptiveCards/templating/language.md :bulb:Suggestion Details
AdaptiveCards/templating/sdk.md :bulb:Suggestion Details

AdaptiveCards/templating/language.md

  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
  • Line 325, Column 28: [Suggestion: preserve-view-not-set - See documentation] Did you mean to link to a specific version? It's usually better not to specify a version, so the link always goes to the canonical version. If you really need to link to a specific version, add &preserve-view=true to the URL: /azure/bot-service/bot-builder-concept-adaptive-expressions?view=azure-bot-service-4.0. Otherwise, remove the view parameter.

AdaptiveCards/templating/sdk.md

  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.
  • Line 193, Column 625: [Suggestion: preserve-view-not-set - See documentation] Did you mean to link to a specific version? It's usually better not to specify a version, so the link always goes to the canonical version. If you really need to link to a specific version, add &preserve-view=true to the URL: /azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions?view=azure-bot-service-4.0#date-and-time-functions. Otherwise, remove the view parameter.

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

opbld31 avatar Apr 18 '22 16:04 opbld31