kaggrwal / steampipe-plugin-bitfinex Goto Github PK

Hey @kaggrwal, thanks for creating this exciting new plugin.

The basic structure and results look good so far. While using the plugin, we did come up with a few suggestions based on our best practices:

1. The name of the repository should be steampipe-plugin-bitfinex.
2. README.md suggestions:

• It is missing the links to the hub documentation and the slack community. For instance, the README section usually begins in the following manner:

# PagerDuty Plugin for Steampipe

Use SQL to query infrastructure services, teams, escalation policies and more from your PagerDuty account.

- **[Get started →](https://hub.steampipe.io/plugins/turbot/pagerduty)**
- Documentation: [Table definitions & examples](https://hub.steampipe.io/plugins/turbot/pagerduty/tables)
- Community: [Slack Channel](https://steampipe.io/community/join)
- Get involved: [Issues](https://github.com/turbot/steampipe-plugin-pagerduty/issues)

• steampipe plugin install bitfinex should be replaced by steampipe plugin install kaggrwal/bitfinex.
• Could you please add the missing Contributing section?

For the above points, you could refer https://raw.githubusercontent.com/turbot/steampipe-plugin-pagerduty/main/README.md for additional information.

3. docs/index.md suggestions:

• organization should be kaggrwal.
• display_name should be Bitfinex instead of BITFINEX. Is there any specific reason why BITFINEX has been used?
• name placeholder should be updated to short_name.
• All references to BITFINEX should be replaced with Bitfinex.
• The example query used in the README and the docs/index.md files should be the same. I personally prefer the one used in the docs/index.md file.
• The install section needs to be updated in the following manner:

Now

  steampipe plugin install bitfinex

Suggested

  steampipe plugin install kaggrwal/bitfinex

• The configuration section should be updated as follows:

  connection "bitfinex" {
  plugin = "kaggrwal/bitfinex"
}

For the above points, you could refer https://raw.githubusercontent.com/francois2metz/steampipe-plugin-gandi/main/docs/index.md for help

4. The config/bitfinex.spc file should use plugin = "kaggrwal/bitfinex" instead of plugin = "bitfinex".

5. The description section, of the table column data, is missing the period . at its end.

6. The table docs look a bit light and need not include result sets and implementation notes. When the plugin is released to the hub the inspect data would automatically show up, for instance, https://hub.steampipe.io/plugins/francois2metz/gandi/tables/gandi_domain#inspect.

Could we add 2-3 more examples for the table docs?

Overall the plugin looks great. The changes that need to be made are very minor. Please let us know in case you have any questions.

Looking forward to releasing the plugin to the hub 👍 .