Migrate profiler enabling docs to single Cdocs page#35099
Draft
brett0000FF wants to merge 4 commits intomasterfrom
Draft
Migrate profiler enabling docs to single Cdocs page#35099brett0000FF wants to merge 4 commits intomasterfrom
brett0000FF wants to merge 4 commits intomasterfrom
Conversation
Contributor
Consolidate 10 separate language-specific profiler enabling pages (Java, Python, Go, Ruby, Node.js, .NET, PHP, GraalVM, ddprof) into a single filterable Cdocs page using Markdoc. - Add prog_lang filter with 10 language options - Add dynamic runtime filter (JVM/GraalVM Native Image for Java only) - Create new runtime trait, c/jvm/graalvm_native_image options - Create profiler option groups with dynamic per-language runtime groups - Convert all Hugo shortcodes to Markdoc tags - Consolidate all aliases from deleted pages
Replace dynamic <PROG_LANG>_profiler_runtime_options with static java_profiler_runtime_options and show_if condition. Removes 9 redundant single-option runtime groups for non-Java languages.
brett0000FF
force-pushed
the
brett.blue/profiler-enabling-cdocs-migration
branch
from
3b02eb0 to
a26266f
Compare
…e links - Extract inline content into Cdocs partials under layouts/shortcodes/mdoc/en/profiler/enabling/ - Remove per-language child entries from side nav (Cdocs filters replace them) - Update profiling-languages.html tiles to use ?prog_lang= query params - Add compiled _index.md to .gitignore
- Merge java_{requirements,installation,configuration} into java.mdoc.md
(and likewise for python, go, ruby, nodejs, php)
- Java partial owns its JVM / GraalVM Native Image runtime branching internally
- _index.mdoc.md becomes a thin language dispatcher; shared outro retained
- Match the self-contained pattern already used by dotnet.mdoc.md and ddprof.mdoc.md
- Add best-practice start/end comments around if-blocks
- Align Java install step 5 with other languages (Troubleshooting link)
- Vale fixes: lifecycle -> life cycle (python), run time -> runtime (go), Oxford comma (php)
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.
What does this PR do? What is the motivation?
Migrates the profiler enabling documentation from 10 separate multi-code-lang pages to a single filterable Cdocs (Markdoc) page.
Changes:
java.md,python.md,go.md,ruby.md,nodejs.md,dotnet.md,php.md,graalvm.md,ddprof.md, and_index.mdinto_index.mdoc.mdprog_langtrait with options: Java (default), Python, Go, Ruby, Node.js, .NET, PHP, C, C++, Rustruntimetrait with dynamic option groups per language. Java resolves to JVM/GraalVM Native Image; all other languages resolve to a single "Standard" optionruntimetrait added tocustomization_config/en/traits/general.yamlc,jvm,graalvm_native_imageoptions added tocustomization_config/en/options/general.yamlcustomization_config/en/option_groups/profiler.yamlwith language and per-language runtime option groupstabs,alert,img,br)supported_versions.md,ssi.md, andfull_host.mdare NOT modifiedNote: The dynamic runtime filter uses
<PROG_LANG>_profiler_runtime_options— for non-Java languages, the runtime filter shows a single "Standard" option. Need to verify if Cdocs hides single-option filters automatically.Merge instructions
Merge readiness:
Additional notes
.mdoc.mdsource files are committed; compiled.mdoutput is not includedfurther_readingfrontmatter uses generic profiler links (language-specific blog links from the original pages were not carried over since frontmatter can't be filtered)