influxdata / influxdata/influxdb3_plugins

req: Easier setup and configuration for notification sender plugin

Open
#56 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
37
Forks
24
Avg merge
16h 16m
Merged PRs (30d)
17

Description

When trying to configure the Notification Sender, it's very unclear what the UI is asking for. The "Trigger Name" field is seemingly asking for a cron parameter, but is very particular about what it'll accept, with no documentation for how exactly it should be formatted. This is in contradiction to the plugin documentation saying no trigger arguments are required. The documentation also discusses needing webhook URLs, but the Explorer UI window seems to suggest wanting an API endpoint, which are also different from each other.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the Notification Sender plugin documentation with the Explorer UI, focusing on Trigger Name formatting, trigger arguments, webhook URLs, and API endpoints. Trace where these configuration prompts are defined and decide whether the documentation, UI, or both need to change; done means a new user can configure the sender without conflicting guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.