NVIDIA-NeMo / NVIDIA-NeMo/DataDesignerPlugins
Publish the generated catalog at a stable raw JSON tap URL
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
Parent epic: #15
Depends on: #17
Why
DataDesigner needs one default NVIDIA tap URL that users can consume without GitHub API auth. Since the generated catalog is checked in at catalog/plugins.json, the default should be the unauthenticated raw GitHub URL for that file.
Default NVIDIA tap URL:
https://raw.githubusercontent.com/NVIDIA-NeMo/DataDesignerPlugins/main/catalog/plugins.json
The tap contract is transport-generic: any HTTP(S) URL or local path that resolves to raw schema v2 JSON is a tap. Human docs should link to the raw JSON URL; they are not the machine-readable catalog delivery path.
Implementation
- Add
[tool.ddp.tap].catalog-urlwith the exact default URL above as part of #21. - Keep
catalog/plugins.jsonas the checked-in generated source of truth. - Do not add a docs/Pages publishing requirement for the machine-readable tap.
- Document freshness semantics:
.../main/catalog/plugins.jsontracks acceptedmainand is mutable.- tag-pinned raw URLs are immutable snapshots, for example
https://raw.githubusercontent.com/NVIDIA-NeMo/DataDesignerPlugins/<tag-or-sha>/catalog/plugins.json. - release assets can be added later only if we need a separate snapshot distribution mechanism.
- Add or preserve CI coverage through
make check-catalogplus schema v2 tests from #17. - Update README/docs to identify the default URL and explain that external taps may use any unauthenticated raw JSON endpoint or local file path.
Acceptance criteria
- The default NVIDIA tap URL is exactly documented as
https://raw.githubusercontent.com/NVIDIA-NeMo/DataDesignerPlugins/main/catalog/plugins.json. catalog/plugins.jsonremains generated and checked in.- CI validates the checked-in catalog shape and freshness through
make check-catalogand schema v2 tests. - No issue, docs page, or generated workflow requires GitHub Pages to expose the machine-readable catalog.
- DataDesigner can consume the URL without GitHub API authentication.
Dependencies
- Depends on: #17.
- Blocks: #23, #25, and DataDesigner default tap configuration.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading dependencies #17 and #21, then inspect catalog/plugins.json, the tap configuration, README/docs, and the make check-catalog target. Run make check-catalog and the schema v2 tests from #17. Done means the exact raw URL is documented, the checked-in catalog remains validated, and no GitHub Pages requirement is introduced.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, python
- Domain
- build-system, ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100