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

Updating AI Completion Quick Start based on the updated demo code #165

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

Conversation

danvega
Copy link

@danvega danvega commented Jan 9, 2025

@danvega
Copy link
Author

danvega commented Jan 9, 2025

@microsoft-github-policy-service agree company="Broadcom"

Copy link
Contributor

@danvega : Thanks for your contribution! The author(s) have been notified to review your proposed change.

Copy link
Contributor

Learn Build status updates of commit e46e549:

⚠️ Validation status: warnings

File Status Preview URL Details
articles/ai-services/openai/includes/spring.md ⚠️Warning Details

articles/ai-services/openai/includes/spring.md

  • Line 76, Column 2: [Warning: disallowed-html-tag - See documentation] HTML tag 'project' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 78, Column 6: [Warning: disallowed-html-tag - See documentation] HTML tag 'modelVersion' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 79, Column 6: [Warning: disallowed-html-tag - See documentation] HTML tag 'parent' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 80, Column 10: [Warning: disallowed-html-tag - See documentation] HTML tag 'groupId' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 81, Column 10: [Warning: disallowed-html-tag - See documentation] HTML tag 'artifactId' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 82, Column 10: [Warning: disallowed-html-tag - See documentation] HTML tag 'version' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 83, Column 10: [Warning: disallowed-html-tag - See documentation] HTML tag 'relativePath' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 85, Column 6: [Warning: disallowed-html-tag - See documentation] HTML tag 'groupId' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 86, Column 6: [Warning: disallowed-html-tag - See documentation] HTML tag 'artifactId' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 87, Column 6: [Warning: disallowed-html-tag - See documentation] HTML tag 'version' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 88, Column 6: [Warning: disallowed-html-tag - See documentation] HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 89, Column 6: [Warning: disallowed-html-tag - See documentation] HTML tag 'description' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 90, Column 6: [Warning: disallowed-html-tag - See documentation] HTML tag 'properties' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 94, Column 6: [Warning: disallowed-html-tag - See documentation] HTML tag 'dependencies' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 95, Column 10: [Warning: disallowed-html-tag - See documentation] HTML tag 'dependency' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 96, Column 14: [Warning: disallowed-html-tag - See documentation] HTML tag 'groupId' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 97, Column 14: [Warning: disallowed-html-tag - See documentation] HTML tag 'artifactId' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 99, Column 10: [Warning: disallowed-html-tag - See documentation] HTML tag 'dependency' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 100, Column 14: [Warning: disallowed-html-tag - See documentation] HTML tag 'groupId' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 101, Column 14: [Warning: disallowed-html-tag - See documentation] HTML tag 'artifactId' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 103, Column 10: [Warning: disallowed-html-tag - See documentation] HTML tag 'dependency' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 104, Column 14: [Warning: disallowed-html-tag - See documentation] HTML tag 'groupId' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 105, Column 14: [Warning: disallowed-html-tag - See documentation] HTML tag 'artifactId' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 106, Column 14: [Warning: disallowed-html-tag - See documentation] HTML tag 'scope' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 110, Column 1: [Warning: code-block-indented - See documentation] Indented code blocks aren't allowed. Use a Markdown code block surrounded by triple backticks (```).

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions 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:

@Jak-MS
Copy link
Contributor

Jak-MS commented Jan 9, 2025

@mrbullwinkle
Can you review the proposed changes?

Important: When the changes are ready for publication, adding a #sign-off comment is the best way to signal that the PR is ready for the review team to merge.

NOTE: @danvega - the validation errors are due to the misalignment of the XML code block. The backticks are indented so the code needs to be indented to line up beneath it.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automator prmerger-automator bot added the aq-pr-triaged C+L Pull Request Review Team label label Jan 9, 2025
@bmitchell287
Copy link

@mrbullwinkle - Would you please validate this spring update from Dan Vega and sign off? Please contact me if additional support is needed. Thank you! cc: @KarlErickson

articles/ai-services/openai/includes/spring.md Outdated Show resolved Hide resolved
articles/ai-services/openai/includes/spring.md Outdated Show resolved Hide resolved
Copy link
Contributor

Learn Build status updates of commit a03e125:

⚠️ Validation status: warnings

File Status Preview URL Details
articles/ai-services/openai/includes/spring.md ⚠️Warning Details

articles/ai-services/openai/includes/spring.md

  • Line 45, Column 1: [Warning: code-block-indented - See documentation] Indented code blocks aren't allowed. Use a Markdown code block surrounded by triple backticks (```).
  • Line 192, Column 1: [Warning: code-block-indented - See documentation] Indented code blocks aren't allowed. Use a Markdown code block surrounded by triple backticks (```).

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions 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:

@bmitchell287
Copy link

@mrbullwinkle - @KarlErickson provided some small formatting suggestions that Dan fixed. Is this good to go on your end? Thanks!

@KarlErickson
Copy link

@mrbullwinkle @bmitchell287 @danvega there are still spacing/indentation issues. We don't use tabs, so all tabs should be replaced with spaces. Other changes:

  • Lines 45-66 should not be indented. Indentations within the snippet should be 4 spaces.
  • Lines 75-140 should only be indented 3 spaces so that the top-level elements align with the triple-backtick on lines 74 and 141. Indentations within the snippet should be 4 spaces.
  • Lines 145-179 should be indented 3 spaces. Indentations within the snippet should be 4 spaces.
  • Lines 192-207 should not be indented.

@danvega
Copy link
Author

danvega commented Jan 23, 2025

  • Updated 45 & 66 not indented. Lines within the snippet are now 4 spaces
  • lines 75 & 40 indented 3 spaces, within the snippet are 4 spaces
  • lines 145 & 179 3 spaces, within the code fence 4 spaces
  • lines 192 - 207 no indentation

Copy link
Contributor

Learn Build status updates of commit c636295:

✅ Validation status: passed

File Status Preview URL Details
articles/ai-services/openai/includes/spring.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
File Change Percent This PR contains file(s) with more than 30% file change.

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

Successfully merging this pull request may close these issues.

5 participants