Skip to content

Update metadata_customized_docs.json: add spec dir sturcture, api versions and branches, breaking changes deep dive; remove avocado as it is obsolete #8029

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 16, 2024
Merged

Update metadata_customized_docs.json: add spec dir sturcture, api versions and branches, breaking changes deep dive; remove avocado as it is obsolete #8029

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
211c057
Update metadata_customized_docs.json: add dir sturcture, api versions…
Apr 6, 2024
47a6eab
Update metadata_customized_docs.json
Apr 16, 2024
7400c39
Update metadata_customized_docs.json
Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions tools/sdk-ai-bots/Embeddings/settings/metadata_customized_docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,24 @@
"title": "AutoRest Extensions for OpenAPI 2.0",
"url": "https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md"
},
"avocado-readme.md": {
"title": "Avocado Readme",
"url": "https://github.com/Azure/avocado/blob/main/README.md"
},
"control_plane_template.md": {
"title": "Control plane pull request template",
"url": "https://github.com/Azure/azure-rest-api-specs/blob/main/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md"
},
"data_plane_template.md": {
"title": "Data plane pull request template",
"url": "https://github.com/Azure/azure-rest-api-specs/blob/main/.github/PULL_REQUEST_TEMPLATE/data_plane_template.md"
},
"directory-structure.md": {
"title": "azure-rest-api-specs repos directory structure",
"url": "https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/directory-structure.md"
},
"pr-brch-deep.md": {
"title": "Breaking Changes process deep dive",
"url": "https://eng.ms/docs/products/azure-developer-experience/design/specs-pr-guides/pr-brch-deep"
Copy link
Contributor Author

@konrad-jamrozik konrad-jamrozik Apr 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@raych1 are links from eng.ms/docs going to work? If not, maybe from the sources, like e.g. https://dev.azure.com/azure-sdk/internal/_git/azure-sdk-docs-eng.ms?path=/docs/design/api-specs-pr/api-versions-and-branches.md

?

Here:

I found this:

Capability of this bot

This bot can provide general QA by searching through a knowledge base that includes documents from three sources:

Azure SDK documents available at the engineering hub site
TypeSpec documents available at https://github.com/azure/typespec-azure
Some markdown documents from a customized list

I guess this means there is no need to explicitly include anything from https://eng.ms/docs/products/azure-developer-experience as the bot should slurp all the docs there?

Copy link
Member

@raych1 raych1 Apr 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@konrad-jamrozik
You are correct. The documents under eng.ms/docs are added to the document source of the bot by default. There is no need to add them to customized docs list. The other hand, the document in the customized list must be publicly accessible. Otherwise, the pipeline cannot fetch it.

},
"api-versions-and-branches.md": {
"title": "API versions and branches",
"url": "https://eng.ms/docs/products/azure-developer-experience/design/api-specs-pr/api-versions-and-branches"
}
}
}