Skip to content

Add related learning catalogue and directive - #3943

Draft
lcawl wants to merge 2 commits into
mainfrom
learning-links-directive
Draft

Add related learning catalogue and directive#3943
lcawl wants to merge 2 commits into
mainfrom
learning-links-directive

Conversation

@lcawl

@lcawl lcawl commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR is an alternative version of #3877

It enables authors to add links from the shared link catalogue as-needed via a directive on their page.
For example:

:::{related-learning}
:ids: apm-with-elastic
:::

Details

:ids: is required (comma-separated, display order). :heading: is optional (default Related learning, TOC slug related-learning-heading). Unknown IDs fail the build; duplicates warn and are skipped.

Tests

I added a directive like this to a page in docs-content:

:::{related-learning}
:ids: index-basics, data-types-and-mappings
:::

When I run ./build.sh publishbinaries then use that build to serve the docs-content docs, I see the new section:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant