sync new doc for bot #13696
sync new doc for bot #13696
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds new documentation sources to the Azure SDK QA bot knowledge sync configuration. It references two repositories containing OpenAPI Diff (OAD) rules documentation to enhance the bot's knowledge base about breaking changes and API diff rules.
Changes:
- Added azure-rest-api-specs repository configuration to sync the BreakingChange-Oad-Rules-Mapping.md document
- Added openapi-diff repository configuration to sync OAD rules documentation from the /docs directory
| }, | ||
| "paths": [ | ||
| { | ||
| "description": "Azure REST API Breaking Change And Oad Rules Mapping", |
There was a problem hiding this comment.
The description has inconsistent capitalization. "And" should be lowercase "and", and "Oad" should be uppercase "OAD" to match the standard acronym format.
| }, | ||
| "paths": [ | ||
| { | ||
| "description": "oad rules", |
There was a problem hiding this comment.
The description "oad rules" lacks proper capitalization and is inconsistent with other descriptions in the file. It should use the uppercase acronym "OAD" and follow a more descriptive pattern similar to other entries. Consider something like "OpenAPI Diff (OAD) rules documentation" or "OAD rules documentation".
| "description": "oad rules", | |
| "description": "OpenAPI Diff (OAD) rules documentation", |
| { | ||
| "description": "Azure REST API Breaking Change And Oad Rules Mapping", | ||
| "path": "/documentation/BreakingChange-Oad-Rules-Mapping.md", | ||
| "folder": "static_azure_docs", |
There was a problem hiding this comment.
You can not reuse the static_azure_docs folder of the storage container, the folder with 'static' prefix only for the documents uploaded to the storage by manual but not by sync pipeline. You should define a new folder like 'azure_rest_api_specs_docs'
| { | ||
| "description": "oad rules", | ||
| "path": "/docs", | ||
| "folder": "static_azure_docs", |
|
After fix the config, you should follow this document to add the new knowledge source and update the tenant config: https://github.com/Azure/azure-sdk-tools/blob/main/tools/sdk-ai-bots/docs/SELF_SERVE_ADD_KNOWLEDGE_SOURCES.md |
| { | ||
| "repository": { | ||
| "url": "https://github.com/Azure/azure-rest-api-specs.git", | ||
| "branch": "master", |
There was a problem hiding this comment.
This repo uses main not master as the default branch.
fixes https://github.com/Azure/azure-sdk-pr/issues/2509