docs(09,10,13): normalise stale deployment suffix; placeholder in 13-00 prose#15
Merged
Merged
Conversation
…00 prose
13-00-guardrails.md portal-fallback section had a hard-coded resource
name aif-core-6fe574, which is the author's deployment suffix - users
following the doc against their own deployment will see a different
suffix. Replaced with aif-core-{suffix} to match the placeholder
convention used everywhere else in prose.
Also normalised the stale 6fe574 suffix to the current canonical
demonstration suffix c2676f across cached outputs in 3 notebooks
(09-01, 09-02, 10-03). Two suffixes co-existed because the cached
outputs were captured from two different deployment generations;
readers now see a single consistent suffix throughout.
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
1 participant
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.
Summary
Two related fixes:
1.
13-00-guardrails.mdportal fallback (the bug)Section "Portal fallback" referenced a hard-coded
aif-core-6fe574as the resource to open in the Azure portal. That's the author's deployment suffix - users following the doc against their own deployment have a different suffix, so the instruction was misleading. Replaced withaif-core-{suffix}to match the placeholder convention used everywhere else in prose.2. Normalised stale
6fe574suffix in 3 notebook cached outputsWhile scanning for the bug above, found
6fe574(a stale suffix from an earlier deployment generation) lingering in cached cell outputs across three notebooks. Those outputs were captured before the currentc2676fdemonstration suffix became canonical, so readers see two different suffixes depending on which notebook they're in:09-content-understanding-integration/09-01-deploy-setup.ipynb(11 occurrences)09-content-understanding-integration/09-02-cu-analyze.ipynb(2)10-foundry-iq/10-03-knowledge-base-setup.ipynb(2)Normalised all 15 to
c2676fso the demonstration suffix is consistent across the repo. Per the repo's hygiene policy (per 0.3.0 / 0.5.0 changelog entries), deterministic suffixes in cached outputs are kept rather than placeholder'd - this PR keeps with that policy, just makes the kept value consistent.Test plan
grep -r 6fe574 --include='*.md' --include='*.ipynb'returns nothing across the repoaif-core-{suffix}Patch release 0.8.7.