Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DRAFT] Update templating documentation #448

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

anna-dingler
Copy link

@anna-dingler anna-dingler commented Apr 15, 2022

Updating templating documentation for the following changes:

microsoft/AdaptiveCards#7199
microsoft/AdaptiveCards#7209

Not ready to merge until next release.

Microsoft Reviewers: Open in CodeFlow

@opbld31
Copy link

opbld31 commented Apr 15, 2022

Docs Build status updates of commit 76eaaab:

⚠️ Validation status: warnings

File Status Preview URL Details
AdaptiveCards/templating/language.md ⚠️Warning Details
AdaptiveCards/templating/sdk.md 💡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
Copy link

opbld31 commented Apr 18, 2022

Docs Build status updates of commit 3661c5a:

✅ Validation status: passed

File Status Preview URL Details
AdaptiveCards/templating/language.md 💡Suggestion Details
AdaptiveCards/templating/sdk.md 💡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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants