HDDS-9858. Add comprehensive user guide documentation.#150
Closed
kerneltime wants to merge 12 commits intoapache:HDDS-9225-website-v2from
Closed
HDDS-9858. Add comprehensive user guide documentation.#150kerneltime wants to merge 12 commits intoapache:HDDS-9225-website-v2from
kerneltime wants to merge 12 commits intoapache:HDDS-9225-website-v2from
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR replaces placeholder user guide content with complete, detailed documentation for client interfaces and system integrations in Apache Ozone. Key changes include:
- Removal of stub integration and client pages under
03-integrationsand02-clients. - Addition of full integration guides under
02-integrations(Hive, Hue, Iceberg, Impala, Oozie, Spark, Trino). - Expansion of client interface docs under
01-client-interfacesand updates to the spelling dictionary.
Reviewed Changes
Copilot reviewed 26 out of 39 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/04-user-guide/03-integrations/README.mdx | Removed placeholder integrations overview |
| docs/04-user-guide/02-integrations/README.mdx | Added main integrations overview with DocCardList navigation |
| docs/04-user-guide/02-integrations/*.md | Added full integration guides for Hive, Hue, Iceberg, Impala, Oozie, Spark, Trino |
| docs/04-user-guide/02-clients/*.md | Removed placeholders; introduced new client-specific docs |
| docs/04-user-guide/01-client-interfaces/*.md | Expanded client interface documentation for o3, ofs, s3, s3a, HTTPFS, Java API |
| cspell.yaml | Updated custom spelling dictionary with technical terms |
Comments suppressed due to low confidence (6)
docs/04-user-guide/02-integrations/06-spark.md:1
- Add meaningful frontmatter (e.g.,
sidebar_label: Spark) between the---markers so the page shows up correctly in the sidebar.
---
docs/04-user-guide/02-integrations/05-oozie.md:1
- Include frontmatter (
---withsidebar_label: Oozie) at the top so this MD file is properly recognized and labeled in the docs navigation.
# Apache Oozie Integration
docs/04-user-guide/02-integrations/04-impala.md:1
- Add YAML frontmatter (
---andsidebar_label: Impala) to ensure this page is included and labeled in the sidebar correctly.
# Impala
docs/04-user-guide/02-integrations/03-iceberg.md:1
- This file lacks frontmatter; please add
---with asidebar_label: Icebergfor consistent navigation.
# Apache Iceberg
docs/04-user-guide/02-integrations/02-hue.md:5
- Add frontmatter (
---withsidebar_label: Hue) above the heading to enable proper labeling in the documentation sidebar.
# Integrating Apache Hue with Ozone
docs/04-user-guide/02-integrations/01-hive.md:5
- Frontmatter (
---withsidebar_label: Hive) is missing; please add it so this guide is included in the navigation.
# Using Apache Hive with Ozone
This adds complete user guide documentation with: - Client interfaces documentation (o3, ofs, s3, s3a, httpfs, java-client-api) - Integration guides (Hive, Hue, Iceberg, Impala, Oozie, Spark, Trino) - All associated integration logos and images - Proper navigation structure with DocCardList components - Updated spelling dictionary for technical terms The documentation provides detailed configuration instructions, usage examples, and best practices for each client interface and integration. Replaces placeholder content with comprehensive guides for end users to interact with Ozone storage systems. Generated-by: Claude and Gemini
0f45085 to
d62d0c9
Compare
3 tasks
jojochuang
reviewed
Feb 8, 2026
Contributor
jojochuang
left a comment
There was a problem hiding this comment.
The user guide doc section is almost complete, with a few (Hue, Spark) still being workd on. I think we can close this one.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
This adds complete user guide documentation with:
The documentation provides detailed configuration instructions, usage examples, and best practices for each client interface and integration. Replaces placeholder content with comprehensive guides for end users to interact with Ozone storage systems.
Generated-by: Claude and Gemini
What is the link to the Apache Jira?
HDDS-9858
How was this patch tested?
Check off which of the following tests were done on this change. If additional testing was done, please elaborate here as well.