-
Notifications
You must be signed in to change notification settings - Fork 46
HDDS-9858. Add comprehensive user guide documentation. #150
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.
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
base: HDDS-9225-website-v2
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
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.