Skip to content

HBASE-29878 Improve the Documentation UI (addendum)#7842

Draft
PDavid wants to merge 8 commits intoapache:masterfrom
PDavid:HBASE-29878-ignore-mdx-rat
Draft

HBASE-29878 Improve the Documentation UI (addendum)#7842
PDavid wants to merge 8 commits intoapache:masterfrom
PDavid:HBASE-29878-ignore-mdx-rat

Conversation

@PDavid
Copy link
Contributor

@PDavid PDavid commented Mar 3, 2026

  • Ignore .mdx files in RAT check. The problem is that every MDX file starts with the frontmatter section and the docs library parses it expecting it to be at the start.
  • Fix licenses of old book.html and it's CSS files.
  • Ignore the generated hbase-website/app/pages/_docs/docs/_mdx/(multi-page)/configuration/hbase-default.md file from spotless check
  • Install playwright OS package dependencies in Yetus General Check GitHub Actions workflow based on this: https://playwright.dev/docs/ci-intro#setting-up-github-actions

The .mdx files does not have ASF license header. It is a bit hairy to add comments to .mdx files. Ignore them in RAT check.
@PDavid PDavid self-assigned this Mar 3, 2026
@PDavid
Copy link
Contributor Author

PDavid commented Mar 3, 2026

The problem is that every MDX file starts with the frontmatter section:

---
title: "Preface"
description: "This is the official reference guide for the HBase version it ships with."
---

The docs library parses it expecting it to be at the start.

Copy link
Contributor

@yuriipalam yuriipalam left a comment

Choose a reason for hiding this comment

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

Many thanks! 👍

@PDavid PDavid force-pushed the HBASE-29878-ignore-mdx-rat branch from 083832b to a1255e1 Compare March 3, 2026 14:54
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