Skip to content

Rework "Import a dashboard" for the Dashboards API workflow (applies-switch) and move it under Manage dashboards #7166

Description

@florent-leborgne

Summary

The Import a dashboard page still presents the Saved Objects NDJSON import as the primary, recommended way to move a dashboard between spaces, instances, or deployments. Since 9.4 introduced the Dashboards API (technical preview) for managing dashboards as code, we already reworked the Export JSON section of Share and export dashboards into an applies-switch (Dashboards API JSON for 9.4+, Saved Objects NDJSON for 9.0–9.3) and stopped promoting the older path. The import page needs the same treatment to stay consistent.

We also agreed with the PM to fix the information architecture: Import a dashboard (and likely Share and export dashboards) belong under Manage dashboards, not under Build a dashboard where import currently sits.

Why this needs docs: The import page recommends a workflow the product is moving away from, which contradicts the narrative already applied to the export section, and it sits under the wrong parent in the navigation.

Resources

  • Precedent to mirror: the "Export JSON" applies-switch in Share and export dashboards (explore-analyze/dashboards/sharing.md).
  • Dashboards API reference
  • Related pages: Manage dashboards as code (explore-analyze/dashboards/manage-dashboards-as-code.md), Create dashboards programmatically (explore-analyze/dashboards/create-dashboards-programmatically.md).

Writer-initiated rework agreed with the PM — no source PR.

Availability

Channel Details
Stack Technical preview, 9.4+ (Dashboards API path)
Serverless Technical preview
Feature status Preview
Feature flag None

Suggested edits

Import a dashboard > whole page

  • What the docs say: "Import dashboards into Kibana from NDJSON files exported from other Kibana instances or spaces … making it easy to migrate dashboards between environments or share them with other teams." The Saved Objects NDJSON import is presented as the primary path.
  • What to add: Restructure the page into an applies-switch mirroring the "Export JSON" section in sharing.md. In the 9.4+/serverless tab, route by use case — copy to space for moves within one deployment, and the Dashboards API / manage-as-code for cross-deployment or code-based workflows — and demote NDJSON import to a "still available, not recommended" note. Keep the current Saved Objects NDJSON import steps in a 9.0–9.3 tab. Applies from 9.4.0 (technical preview) and in serverless.

Dashboards navigation / TOC > information architecture

  • What the docs say: dashboards/import-dashboards.md is nested under Build a dashboard; dashboards/sharing.md sits at the dashboards top level.
  • What to add: Move dashboards/import-dashboards.md (and likely dashboards/sharing.md) under dashboards/managing.md ("Manage dashboards") in explore-analyze/toc.yml. Add redirects.yml entries for both moved URLs and update the cross-references that point to them under "Build" (the nav lists in dashboards.md and building.md). Information-architecture change only — no applies_to change.

Metadata

Metadata

Labels

Team:SKIIssues owned by the SKI Docs Team

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions