Skip to content

Update list-template.md | fix metadata to conform to new guidelines#8368

Merged
AllyW merged 2 commits into
mainfrom
dbradish-microsoft-patch-1
Feb 8, 2025
Merged

Update list-template.md | fix metadata to conform to new guidelines#8368
AllyW merged 2 commits into
mainfrom
dbradish-microsoft-patch-1

Conversation

@dbradish-microsoft
Copy link
Copy Markdown
Contributor

@dbradish-microsoft dbradish-microsoft commented Dec 13, 2024

According to the allowed values for ms.topic as now showing in the Contributor's Guide (https://review.learn.microsoft.com/en-us/help/platform/metadata-taxonomies/mstopic?branch=main), the ms.topic for autogenerated reference content should be language-reference. By making this update, the available extensions report will also be removed from MSFT's broken link report. We'll still be able to monitor broken links from the azure-docs-cli repo's daily build report.

Second, the ms.devlang, ms.tool and keyword metadata has been deprecated.

This PR fixes the following build error:

image

According to the allowed values for `ms.topic` as now showing in the Contributor's Guide (https://review.learn.microsoft.com/en-us/help/platform/metadata-taxonomies/mstopic?branch=main), the ms.topic for autogenerated reference content should be `language-reference`. By making this update, the available extensions report will also be removed from management's broken link report. We'll still be able to monitor broken links from the azure-docs-cli repo's daily build report.
@azure-client-tools-bot-prd
Copy link
Copy Markdown

Hi @dbradish-microsoft,
Please write the description of changes which can be perceived by customers into HISTORY.rst.
If you want to release a new extension version, please update the version in setup.py as well.

@azure-client-tools-bot-prd
Copy link
Copy Markdown

azure-client-tools-bot-prd Bot commented Dec 13, 2024

️✔️Azure CLI Extensions Breaking Change Test
️✔️Non Breaking Changes

@yonzhan
Copy link
Copy Markdown
Collaborator

yonzhan commented Dec 13, 2024

Thank you for your contribution! We will review the pull request and get back to you soon.

@github-actions
Copy link
Copy Markdown
Contributor

🚫All pull requests will be blocked to merge until Jan 6, 2025 due to CCOA

@github-actions
Copy link
Copy Markdown
Contributor

@dbradish-microsoft
Copy link
Copy Markdown
Contributor Author

@jsntcy, This is a metadata update for the Available Azure CLI Extensions report. Can we please publish?

@dbradish-microsoft
Copy link
Copy Markdown
Contributor Author

@jsntcy , @yonzhan , what needs to happen to get this metadata change published?

Comment thread scripts/ci/avail-ext-doc/list-template.md Outdated
@AllyW AllyW removed the do-not-merge label Feb 7, 2025
@AllyW AllyW merged commit 8cc7f6d into main Feb 8, 2025
Jenniferyingni pushed a commit to Jenniferyingni/azure-cli-extensions that referenced this pull request Feb 9, 2025
…zure#8368)

* Update list-template.md | fix metadata to conform to new guidelines

According to the allowed values for `ms.topic` as now showing in the Contributor's Guide (https://review.learn.microsoft.com/en-us/help/platform/metadata-taxonomies/mstopic?branch=main), the ms.topic for autogenerated reference content should be `language-reference`. By making this update, the available extensions report will also be removed from management's broken link report. We'll still be able to monitor broken links from the azure-docs-cli repo's daily build report.

* Update ms.topic to generated-reference
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.

5 participants