Skip to content

Migrate profiler enabling docs to single Cdocs page#35099

Draft
brett0000FF wants to merge 1 commit intomasterfrom
brett.blue/profiler-enabling-cdocs-migration
Draft

Migrate profiler enabling docs to single Cdocs page#35099
brett0000FF wants to merge 1 commit intomasterfrom
brett.blue/profiler-enabling-cdocs-migration

Conversation

@brett0000FF
Copy link
Contributor

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:

  • Consolidate java.md, python.md, go.md, ruby.md, nodejs.md, dotnet.md, php.md, graalvm.md, ddprof.md, and _index.md into _index.mdoc.md
  • Filter 1 — Language: prog_lang trait with options: Java (default), Python, Go, Ruby, Node.js, .NET, PHP, C, C++, Rust
  • Filter 2 — Runtime (dynamic): runtime trait with dynamic option groups per language. Java resolves to JVM/GraalVM Native Image; all other languages resolve to a single "Standard" option
  • New runtime trait added to customization_config/en/traits/general.yaml
  • New c, jvm, graalvm_native_image options added to customization_config/en/options/general.yaml
  • New customization_config/en/option_groups/profiler.yaml with language and per-language runtime option groups
  • All Hugo shortcodes converted to Markdoc tags (tabs, alert, img, br)
  • All aliases from deleted pages consolidated into the new file
  • supported_versions.md, ssi.md, and full_host.md are NOT modified

Note: 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:

  • Ready for merge

Additional notes

  • Only .mdoc.md source files are committed; compiled .md output is not included
  • The further_reading frontmatter uses generic profiler links (language-specific blog links from the original pages were not carried over since frontmatter can't be filtered)

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
@github-actions github-actions bot added the cdocs label Mar 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant