Document plugin tap workflows#35
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a dedicated
docs/taps.mdoverview for Data Designer plugin taps, including the default NVIDIA raw catalog URL, schema v2 example and required fields, source object variants, raw JSON delivery expectations, trust guidance, external tap setup, and maintainer regeneration rules.Updates README, authoring, workflow, releasing, schema reference, docs index, and Zensical navigation so tap discovery, generated catalog ownership, and release/install behavior are documented in the right places.
Why
Consumers need one place to find the default NVIDIA tap URL and understand that the tap is a raw schema v2 JSON catalog, not GitHub Pages or an HTML docs artifact. Maintainers and external tap authors also need clear guidance on which repo metadata feeds catalog entries, when generated files must be refreshed, and how a released package becomes discoverable and installable through a tap.
Usage
Default NVIDIA tap catalog:
External tap authoring flow:
Publish the generated
catalog/plugins.jsonas raw JSON at the configured[tool.ddp.tap].catalog-url. Once Data Designer supports tap configuration, users should add that raw catalog URL through theplugins taps addflow before discovering or installing plugins from the non-default tap.How
docs/taps.mdas the workflow-oriented tap page and linked it from README, docs index, andzensical.tomloutside the generated plugin docs block.docs/tap-catalog-schema-v2.mdas the detailed schema reference and moved workflow/trust emphasis to the new taps page to avoid repeating the same governance content in multiple places.docs/authoring.mdto describeddp new --type column-generator|seed-reader|processor, catalog field inputs,[tool.ddp.tap], generated outputs, and external tap publishing.docs/workflow.mdanddocs/releasing.mdwith raw catalog artifact handling, generated-file validation, per-plugin release tags, PyPI/Git source install derivation, multi-plugin package releases, and strengthened release validation coverage.Validation
make syncmake docsmake checkgit diff --checkmake all