search

Azure-Samples / azure-search-openai-demo-java

This repo is the Java version of Microsoft's sample app for ChatGPT + Enterprise data.
MIT License
67 stars 66 forks source link

Build validation warnings #80

Closed mtrilbybassett closed 3 months ago

mtrilbybassett commented 3 months ago

Please provide us with the following information:

This issue is for a: (mark with an x)

- [ ] bug report -> please search issues before submitting
- [ ] feature request
- [X] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

Page information

Learn site page: https://learn.microsoft.com/en-us/samples/azure-samples/azure-search-openai-demo-java/azure-search-openai-demo-java/

Readme.md: https://github.com/Azure-Samples/azure-search-openai-demo-java/blob/main/README.md?plain=1

Any log messages given by the failure

[!WARNING] Cannot find bookmark '#open-this-project' in 'Azure-Samples/azure-search-openai-demo-java/azure-search-openai-demo-java/index.yml'.

Resolution: (TOC update) Need to add/update section, link, or remove item on 54: https://github.com/Azure-Samples/azure-search-openai-demo-java/blob/main/README.md?plain=1#L54

[!WARNING]
Cannot find bookmark '#existing-azure-cognitive-search-resource' in 'Azure-Samples/azure-search-openai-demo-java/azure-search-openai-demo-java/index.yml'.

Resolution: (TOC update) Need to add/update section, link, or remove item on 62: https://github.com/Azure-Samples/azure-search-openai-demo-java/blob/main/README.md?plain=1#L62

[!WARNING] Cannot find bookmark '#deploying-again' in 'Azure-Samples/azure-search-openai-demo-java/azure-search-openai-demo-java/index.yml'.

Resolution: (TOC update) Need to add/update section, link, or remove item on 65: https://github.com/Azure-Samples/azure-search-openai-demo-java/blob/main/README.md?plain=1#L65

[!WARNING]
Cannot find bookmark '#to-run-in-github-codespaces-or-vs-code-dev-containers' in 'Azure-Samples/azure-search-openai-demo-java/azure-search-openai-demo-java/index.yml', did you mean '#run-in-github-codespaces-or-vs-code-dev-containers'?

Resolution: (TOC update) Need to add/update section, link, or remove item on 67: https://github.com/Azure-Samples/azure-search-openai-demo-java/blob/main/README.md?plain=1#L67

[!WARNING]
Cannot find bookmark '#deploying-from-scratch' in 'Azure-Samples/azure-search-openai-demo-java/azure-search-openai-demo-java/index.yml'.

Resolution: Need to add link on 189: https://github.com/Azure-Samples/azure-search-openai-demo-java/blob/main/README.md?plain=1#L189

[!WARNING]
HTML tag 'azureSubscriptionServiceConnection' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

Resolution: Need to escape HTML on 351: https://github.com/Azure-Samples/azure-search-openai-demo-java/blob/main/README.md?plain=1#L351

Thanks! We'll be in touch soon.