Skip to main content

Documentation Edit and AI Generation Features Not Working in UI

Angelo Bresci
Updated

Area: Product Issues

Sub-Area: Documentation Management

Issue

After upgrading to DataHub Cloud v1.0.0, users experience issues with documentation editing functionality in the UI. The "Edit" button and "Generate with AI" button for table documentation appear disabled or fail silently, and draft documents may disappear from the Documents panel or become inaccessible to their owners.

You Might Be Asking

  • Why can't I edit table documentation after upgrading?
  • Where did the Documentation tab go in the UI?
  • Why can't I see my draft documents anymore?
  • Is the "Generate with AI" button supposed to work?
  • Are these changes permanent or bugs?

Solution

This issue stems from UI changes and permission enforcement introduced in v1.0.0. Follow these steps to resolve:

  1. Verify User Permissions

    Ensure affected users have the required privileges for documentation editing:

    • Navigate to Settings → Access → Policies
    • Check that users have either "Edit Dataset Documentation" or "Propose Dataset Documentation" policies applied
    • Test with an admin user to confirm permissions are the issue
  2. Check AI Documentation Settings

    Verify that AI documentation features are enabled:

    • Go to Settings → Platform → AI
    • Confirm that Documentation AI (documentationAi.enabled) is toggled on
  3. For Missing Draft Documents

    Draft documents may not appear due to visibility filtering:

    • Check Context Hub → Proposals/Inbox to locate draft documents
    • Verify you are listed as an owner of the draft document
    • Use search functionality as a temporary workaround to locate missing documents
  4. For Documents Created via AI Chat

    If documents created through AI chat are not visible:

    # Remove parentDocument field from documentInfo aspect
# Or create a proper shared folder first, then reference it
{
  "documentInfo": {
    // Remove this section for root-level documents:
    // "parentDocument":{"document":"urn:li:document:__system_shared_documents"}
  }
}
  5. Upgrade to Latest Version

    The primary fix requires upgrading to v1.0.1 or later:

    • Contact your DataHub support team to schedule the upgrade
    • The fix restores documentation editing functionality while maintaining the new Summary tab features
    • After upgrade, documentation editing will open in a modal instead of redirecting to a separate tab

Additional Notes

This issue was caused by UI architectural changes in v1.0.0 that introduced stricter permission enforcement and migrated from the legacy document state system to a new lifecycleStage system. The new Summary tab replaced the Documentation tab but initially broke the editing workflow for datasets. The "Generate with AI" feature may require additional fixes in subsequent releases beyond v1.0.1. Draft document visibility issues are related to incomplete migration from the legacy state field to the newer lifecycleStage system.

Related Documentation

Tags: documentation-editing, ai-generation, ui-regression, permissions, draft-documents, v1.0.0-upgrade, summary-tab, context-hub, lifecycle-stage

Related articles