NVIDIA-NeMo / NVIDIA-NeMo/DataDesignerPlugins

Update plugin docs to recommend Data Designer CLI installs

Open
#48 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Context

Data Designer PR NVIDIA-NeMo/DataDesigner#618 adds the client-side data-designer plugin CLI workflow for discovering, inspecting, installing, and uninstalling plugin packages from the DataDesignerPlugins catalog.

Once that PR is merged, the plugin docs in this repo should recommend installing plugins through the Data Designer CLI as the primary path instead of leading with direct pip/uv package installation commands.

Scope

  • Update the plugin user docs to show CLI-first installation guidance, for example data-designer plugin install <package-or-alias> where appropriate.

  • Update the doc-creation / plugin authoring instructions so future plugin docs are generated or written with the CLI-first install recommendation.

  • Add doc-creation guidance that code examples should follow the standard Data Designer import pattern:

    import data_designer.config as dd
    
  • Keep direct pip/uv installation guidance where it is still useful as fallback, troubleshooting, or advanced-package-management guidance.

  • Cross-link the catalog/package naming and alias behavior where that helps users choose the right install target.

Dependency

Wait for NVIDIA-NeMo/DataDesigner#618 to merge before making the CLI recommendation the default docs path.

Acceptance Criteria

  • Plugin docs recommend Data Designer CLI installation once the CLI support has landed.
  • Doc authoring instructions/templates produce or describe CLI-first installation sections for new plugins.
  • Doc authoring instructions/templates tell authors to use import data_designer.config as dd in code examples.
  • Any remaining direct package-manager install instructions are clearly positioned as fallback or advanced guidance.
  • Relevant docs checks pass.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

First verify that NVIDIA-NeMo/DataDesigner#618 has merged, then locate the plugin user documentation and the doc-creation or plugin-authoring instructions and templates. Update those materials to make Data Designer CLI installation primary, retain package-manager guidance as fallback or advanced advice, and use the specified import pattern. Confirm the acceptance criteria and run the relevant documentation checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.