question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Improve Hub plugin definition contribution docs

See original GitHub issue

Background

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):

Hub-only YAML fields:

  • prereqs markdown field
  • settings_preamble markdown field
  • usage 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:closed
  • Created a year ago
  • Comments:10 (4 by maintainers)

github_iconTop GitHub Comments

2reactions
aaronsteerscommented, Jun 8, 2022

That makes sense. I do think the hub should have a page pointing to the Meltano one then.

1reaction
edgarrmondragoncommented, Jul 21, 2022

I’m imagining a yaml reference for plugins modeled after this GitHub Yaml Workflow Reference.

@aaronsteers what’s they say about great minds? That’s what I went for in https://github.com/meltano/meltano/pull/6460 😅

For what it’s worth, I did also investigated automated approached to document the yaml reference based on our JSON Schema, but none of these investigations came up with fruitful/usable libraries.

I did think about that but came similarly with no out-of-the-box solutions.

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found