Skip to content

HBASE-29878 Improve the Documentation UI #7722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
yuriipalam wants to merge 121 commits into
base: master
Choose a base branch
from
Open

HBASE-29878 Improve the Documentation UI #7722

yuriipalam wants to merge 121 commits into from

Conversation

@yuriipalam
Copy link
Contributor

@yuriipalam yuriipalam commented Feb 9, 2026 •
edited
Loading

As discussed earlier here https://lists.apache.org/thread/0ojmobpnyk44lbghqxh2c231c3bm6t6t
I’m presenting the new documentation website. You can check this out here:
https://hbase-landing.vercel.app/docs/

What’s been done:

  • Converted all asciidoc files to mdx (extended markdown). 99% of the content preserved, checked it manually multiple times.
  • Multi-page by default, single-page as an alternative option for those who got used to it.
  • Multi-page has a powerful search. The whole website is static and pre-rendered at a build time.
  • “Edit on GitHub” button is at the bottom of each section that leads directly to the source of the section. Doesn’t work in the demo website because it leads to the original repo, and the change is not merged yet.
  • Dark mode support.
  • The UI now looks modern and beautiful, the user/dev experience is improved significantly.
  • The landing page and documentation are now one application.
  • The PDF generation is integrate into the build process. PDFs are also available in both Dark and Light modes.
  • The old docs are still available at "/book.html" with a banner that the page is legacy, so people with bookmarks/notes won't get the 404 error.

Thanks!

PDavid
PDavid reviewed Feb 10, 2026
View reviewed changes
Copy link
Contributor

@PDavid PDavid 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 Yurii for this nice PR. What a changeset! I think it is a new record. 😃

pom.xml
@@ -2430,7 +2399,7 @@
HBase requires at least version ${maven.min.version} of Maven to properly build from source.
You appear to be using an older version. You can use either "mvn -version" or
"mvn enforcer:display-info" to verify what version is active.
See the reference guide on building for more information: https://hbase.apache.org/book.html#build</message>
See the documentation for more information: https://hbase.apache.org/docs/</message>
Copy link
Contributor

@PDavid PDavid Feb 10, 2026

Choose a reason for hiding this comment

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

Can we maybe link to the relevant chapter here? e.g.
https://hbase-landing.vercel.app/docs/building-and-developing/building

README.md Outdated
Copy link
Contributor

@PDavid PDavid Feb 10, 2026

Choose a reason for hiding this comment

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

Can I ask why the top-level README was deleted? I guess we should restore it?

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

Reviewers

@PDavid PDavid PDavid left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@yuriipalam @PDavid