Skip to content

[docs] Refresh the docs and fix broken commands for the 4.12 release - #4394

Merged
Harshg999 merged 4 commits into
masterfrom
docs/refresh-for-4.12
Oct 30, 2026
Merged

Harshg999 merged 4 commits into
masterfrom
docs/refresh-for-4.12

Conversation

@Harshg999

Copy link
Copy Markdown
Collaborator

What changes are proposed in this pull request?

Prepares the documentation and a few broken code paths for the 4.12 release. Four commits:

  1. [docs] Refresh the user, admin and developer docs for 4.12
    • Align the installation, configuration, API and developer guides with the current code: Python 3.11, Django 5.2, Gunicorn as the default server, the new Importer and Storage Browser.
    • Rewrite the REST file browsing and importer API docs from the real routes and parameters.
    • Remove the outdated Cloudera Manager, CDH, Python 2, gethue CLI and dead JIRA content.
    • Fix the broken anchors and code blocks, and update the release checklist.
  2. [core] Fix management commands with positional arguments on Django 5.2
    • close_queries, close_sessions, beeswax_install_examples, hbase_setup and create_proxy_app read their arguments from args without declaring them, so Django 5.2 rejected them. Declare the arguments and add tests.
    • handle() callers in the code are not affected.
  3. [helm] Remove the disabled hue-api chart pieces and the Compose doc
    • The gethue/compose image no longer exists. Remove the hue-api deployment, service, values and ingress entries (all disabled by default) and the Compose design doc.
  4. [core] Align hue.ini and the ini template with the code defaults
    • Fix defaults and comments that disagree with the Config definitions, remove keys that no longer exist and add the missing user-facing options.

How was this patch tested?

  • The new tests pass (24 tests in the management commands and beeswax management tests). ruff is clean on all changed Python files.
  • The docs site builds with Hugo and has 0 broken internal links. A scan found no raw markdown on any page.
  • Four independent fact-checks of the docs against the code. The confirmed errors were fixed.
  • hue.ini loads in Hue's config loader.
  • Not run: helm lint and helm template, because helm is not installed here. The commands were not run against a live Hive or HBase.

Note: to preview the docs locally, use Hugo 0.62.0 (the version of the docs image). Hugo 0.69.0 collapses the left menu for some pages.

- Align the installation, configuration, API and developer guides with the current code (Python 3.11, Django 5.2, Gunicorn, new Importer and Storage Browser)
- Rewrite the REST file browsing and importer API docs from the real routes and parameters
- Remove the outdated Cloudera Manager, CDH, Python 2, gethue CLI and dead JIRA content
- Fix the broken anchors, code blocks and release checklist
close_queries, close_sessions, beeswax_install_examples, hbase_setup and create_proxy_app read their arguments from args without declaring them, so Django 5.2 rejects them. Declare the arguments and add tests. The callers that invoke handle() directly are not affected.
The gethue/compose image is not available anymore. Remove the Compose design doc and the hue-api deployment, service, values and ingress entries of the Helm chart, which were disabled by default.
Fix the defaults and comments that disagree with the Config definitions (Gunicorn is the default server), remove keys that no longer exist and add the missing user-facing options.
@Harshg999 Harshg999 self-assigned this Oct 30, 2026
@github-actions

Copy link
Copy Markdown

✅ Test files were modified. Ensure that the tests cover all relevant changes. ✅

@github-actions

Copy link
Copy Markdown

UI Code Coverage Report

Lines Statements Branches Functions
Coverage: 33%
40.16% (31638/78763) 32.07% (14993/46738) 26.41% (2415/9142)

@github-actions

Copy link
Copy Markdown

Coverage

Backend Code Coverage Report •
FileStmtsMissBranchBrPartCoverMissing
apps/beeswax/src/beeswax/management/commands
   beeswax_install_examples.py27451982380%53->54, 54–60, 87–89, 91->92, 92, 94–95, 97–98, 100, 112->113, 113–114, 123–126, 146->147, 147–148, 155–158, 190->exit, 199->200, 200, 207->210, 231–234, 236, 304->305, 305–307, 321->323, 323–324, 326->327, 327–330, 413->exit, 424–425, 427–429, 431, 458->459, 459, 460->463, 463
   close_queries.py50198559%70–73, 81->82, 82–87, 89, 91–97, 99
   close_sessions.py42104176%69–72, 79->80, 80–85
apps/hbase/src/hbase/management/commands
   hbase_setup.py50324433%39–42, 44, 46–47, 50, 52–53, 55–56, 59–62, 65–66, 69–72, 75–76, 78–81, 83, 85–87
desktop/core/src/desktop/management/commands
   create_proxy_app.py5641242419%40–48, 50–51, 53–55, 57–58, 60–65, 67, 73–74, 77–83, 85–86, 88–91, 93, 98, 100
TOTAL5701128844219751295347% 

@Harshg999
Harshg999 merged commit 6f01c16 into master Oct 30, 2026
7 checks passed
@Harshg999
Harshg999 deleted the docs/refresh-for-4.12 branch October 30, 2026 11:17
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