Skip to content

GRO-838 Adds support for _includes in docs src - #1295

Draft
bpander wants to merge 3 commits into
masterfrom
gro-838-docs-includes
Draft

GRO-838 Adds support for _includes in docs src#1295
bpander wants to merge 3 commits into
masterfrom
gro-838-docs-includes

Conversation

@bpander

@bpander bpander commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

GRO-838

⚠️ The _docs changes are for demo purposes only. I'll remove 3f6e2a3 before merging. ⚠️

Description

Allows includes from metabase docs src files so tech writers can reuse code that lives entirely in the mb repo.

Adding this to a [mb repo]/docs file will include [mb repo]/docs/_includes/test-md.md

{% include {{ _includes }}/test-md.md %}

Relevant slack thread

How to verify

  • Files that live in [mb repo]/docs/_includes can be included from other files in [mb repo]/docs
  • Both md and html includes should be supported
  • Astro should not generate pages for files in _includes
  • sitemap.xml should be unchanged (should not include entries for _includes)
  • script/docs should not add frontmatter to _includes
  • Build times should not be meaningfully impacted
  • Builds should fail if the include can't be resolved

Demo

https://gro-838-docs-includes.dkkh35gceu2po.amplifyapp.com/docs/latest/embedding/authentication
Screenshot 2026-08-24 at 1 35 00 PM

https://gro-838-docs-includes.dkkh35gceu2po.amplifyapp.com/docs/v0.63/embedding/authentication
Screenshot 2026-08-24 at 1 35 12 PM

@bpander bpander self-assigned this Aug 24, 2026
@linear

linear Bot commented Aug 24, 2026

Copy link
Copy Markdown

GRO-838

@bpander
bpander force-pushed the gro-838-docs-includes branch from d3538f0 to 3f6e2a3 Compare August 24, 2026 17:14
@bpander
bpander marked this pull request as ready for review August 24, 2026 18:21
@bpander
bpander requested review from a team August 24, 2026 18:21

@iethree iethree left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very snazzy. Makes a lot of sense short term.

Longer term, instead of committing to liquid syntax, might we want to move to .mdx + react style components? If we do, does it make sense to support this in the docs only to refactor later?

@bpander

bpander commented Aug 25, 2026

Copy link
Copy Markdown
Contributor Author

does it make sense to support this in the docs only to refactor later?

I had the same thought last night. I also want to see what this looks like with mdx instead of having to support a new variable (_includes) in perpetuity. I'll move this back to draft for now.

@bpander
bpander marked this pull request as draft August 25, 2026 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants