HBASE-29878 Improve the Documentation UI #7722
Conversation
PDavid
left a comment
PDavid
left a comment
There was a problem hiding this comment.
Many thanks Yurii for this nice PR. What a changeset! I think it is a new record. 😃
| @@ -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> | |||
There was a problem hiding this comment.
Can we maybe link to the relevant chapter here? e.g.
https://hbase-landing.vercel.app/docs/building-and-developing/building
README.md
Outdated
There was a problem hiding this comment.
Can I ask why the top-level README was deleted? I guess we should restore it?
Jaehui-Lee
left a comment
Jaehui-Lee
left a comment
There was a problem hiding this comment.
The new docs look much more modern and polished. Great work!
| * @param {string} xmlContent - The content of the hbase-default.xml file | ||
| * @returns {Array<Object>} Array of property objects | ||
| */ | ||
| export function parseProperties(xmlContent) { |
There was a problem hiding this comment.
nit: hbase-default.md has a duplicate entry for hbase.zookeeper.property.initLimit. This is because parseProperties() also picks up the example block inside an XML comment in hbase-default.xml. How about stripping comments before parsing?
| DocsPage as FumaDocsPage, | ||
| DocsTitle as FumaDocsTitle | ||
| } from "@/components/docs/layout/docs/page"; | ||
| import defaultMdxComponents from "fumadocs-ui/mdx"; |
There was a problem hiding this comment.
nit: A link icon appears on heading hover, but it's not clickable since it disappears when moving the cursor toward it. It might be better to just hide it.
|
Heya @yuriipalam can you try squishing down your commit history. I've seen Yetus have trouble when there's too many commits. But, I'm 90% sure that these failures were due to a transient failure in the github API... I've been seeing the fail unicorn a lot lately. Anyway, give that a try, hopefully at least the general check will run. Thank boss! |
4 participants
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:
Thanks!