Improve Hub plugin definition contribution docs
See original GitHub issueBackground
https://docs.meltano.com/contribute/plugins should explain exactly how to build a plugin definition for the Hub, including new values like requires
(https://github.com/meltano/meltano/issues/6106), and the new usage
/prereq
/settings_preamble
properties that build the detail pages.
Spec
To add to plugin definition reference (the yaml stuff):
requires
settings
- and how this relates toconfig
capabilities
- and how tap developers can determine the correct capabilitiescontainer_spec
- per https://github.com/meltano/meltano/issues/6408#issuecomment-1190924489
Hub-only YAML fields:
prereqs
markdown fieldsettings_preamble
markdown fieldusage
markdown field
To add to contributing docs:
- Link to plugin reference page.
- Instructions for submitting.
- Details on how the markdown will be rendered in our readmes docs.
- A small blurb on how we capture metrics for the hub.
- Details on how this shows up on the REST API.
- Info on how users will install the plugin after it is published.
Issue Analytics
- State:
- Created a year ago
- Comments:10 (4 by maintainers)
Top Results From Across the Web
Plugin docs - Kong Docs
Create a publisher directory at _app/_hub/ , such as _app/_hub/your-GitHub-handle (if you are contributing as an individual) or _app/_hub/company-name (if ...
Read more >Plugin Definition Syntax - Meltano Documentation
This document describes the syntax for defining plugins contributed to Meltano Hub.
Read more >backstage/CONTRIBUTING.md at master - GitHub
The value of Backstage grows with every new plugin that gets added. ... If you contribute to the documentation, you might want to...
Read more >Contribution model - Azure DevOps | Microsoft Learn
A contribution is an instance of a contribution type. For example, the Queries hub under the Work hub group is a contribution of...
Read more >Developing plugins - Ansible Documentation
To add a configurable option to your plugin, define it in this format: ... this is required for contributions to Ansible from __future__...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
That makes sense. I do think the hub should have a page pointing to the Meltano one then.
@aaronsteers what’s they say about great minds? That’s what I went for in https://github.com/meltano/meltano/pull/6460 😅
I did think about that but came similarly with no out-of-the-box solutions.