Repository navigation
docs(samples): publish 7 directive-syntax sample tutorials - #15
Merged
Merged
Conversation
Content (19)
Checked 32a901c • ❌ structural errors block this PR check; other findings are notify-only |
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.
Publishes 7 sample tutorials that demonstrate the new directive-grammar / markdown-syntax features, drafted during development of those features in
sap-tutorials/tutorials-imsand now batch-published here per Tom's plan (foundation + 7 features merged to tutorials-ims DEV as #3021–#3028).Each lives at
tutorials/<slug>/<slug>.md, adapted to this repo's v2-parser frontmatter convention (matchingtutorials/v2-example-tutorialandtutorials/tutorial-callout-reference):parser: v2,primary_tag,tags,time,author_name/author_profile, a# Title+<!-- description -->line, and###H3 step headings. In-repo scratch markers (publish: false,private: true,NOT PUBLISHEDnotices) were removed. Several drafts used##(H2) step headings or omittedparser: v2— both make the tutorial parse to 0 steps and fail the structural CI gate — so steps were normalised to###H3 andparser: v2added throughout.The 7 samples
directive-synced-option-tabssyncTabsfrontmatter +sync=OPTION-group qualifierdirective-ui-instructions:menu:ui:icon:kbd:askUI-instruction directivesdirective-callouts:spoiler+:::type[Title]formsdirective-code-blocksplaceholders: auto,treefences,:::walkthroughdirective-rich-media:::figure,:image,::compare,::diagram, image hotspots,::cast, sortable/filterable tablesdirective-content-reuse::includesnippets,:note/:help/:api/:tutorial/:sincereference links,testedWith,::requiresdirective-authoring-aids%% … %%author notes,:::qa-onlyblocks,deprecated-clifreshness lintValidation
tutorial-pr-checks): all 7 pass — frontmatter present,parser: v2, ≥1###step each._snippetsresolution (please confirm)directive-content-reuseuses::include[btp-trial-setup]{region=eu10}. The tutorials-ims include resolver (scripts/parsers/directives/include.ts) resolves a label by matching any snippet key ending with/_snippets/<label>, i.e. a repo-root_snippets/directory — so I placed the snippet at_snippets/btp-trial-setup.md(repo root), not inside the tutorial folder. Two caveats to flag:_snippets/directory and no existing meta-tutorial uses::include, so the repo-root_snippets/convention is unverified end-to-end here — it matches the resolver's expected form but hasn't been exercised against a real fetch of this repo.fetch-tutorials.tspasses an empty snippet map; TODO "content-reuse Task 8+"). Until that lands, the::includein this sample will not expand when the platform fetches it. Flagging for follow-up — the sample's syntax is correct and the snippet is colocated correctly for when pre-fetch is wired.Companion cleanup PR in tutorials-ims removes the in-repo drafts: sap-tutorials/tutorials-ims#3030