docs(tutorial): treat App Insights as already-connected by default#191
Merged
Merged
Conversation
PO running through the tutorial pointed out that section 8's optional App Insights subsection reads as if the resource might not exist, when in fact step 3 (both Path A and Path B) already instructs the reader to attach App Insights to the dev project. Reframe accordingly: - Section 7 callout now leads with 'should already be wired from step 3' and gives a 10-second portal check to confirm. - Section 8 optional subsection now starts with 'you can skip this subsection', shows a 2-row decision table for the verification outcome, and only walks through the override case (a dedicated observability resource) at the end. Adds a 'just click Connect Application Insights in the Foundry portal' fallback for the rare case the resource was not created in step 3. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
PO doing the prompt-agent quickstart pointed out that section 8's optional App Insights subsection reads as if the resource might not exist, when in fact step 3 (both Path A and Path B) already instructs the reader to attach App Insights to the dev project:
microsoft-foundryskill) — the prompt explicitly tells the skill to 'Attach or create an Application Insights resource for telemetry, starting with the dev project.'So the default expectation should be 'it already exists', with a quick verification, and only fall back to manual creation/override if the verification fails.
What changed
Only
docs/tutorial-prompt-agent-quickstart.md. Net: +51 / -26 lines.APPLICATIONINSIGHTS_CONNECTION_STRINGpaste to an 'override which resource telemetry goes to' advanced case at the end.Out of scope
The hosted-agent and end-to-end tutorials have different App Insights flows (wizard-driven, local FastAPI sample needing the env variable to enable OpenTelemetry export) — those are intentionally untouched here. Only the prompt-agent quickstart had the 'might not exist' framing.
Validation
Documentation-only change, no tests required.