linkedin / linkedin/Burrow

Could the `notifier.send-interval` configuration be added to the wiki?

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

Nobody has claimed this yet.

Dominant language
Go
Stars
4k
Forks
818
Avg merge
1h 14m
Merged PRs (30d)
1

Description

The `send-interval` notifier configuration was introduced in https://github.com/linkedin/Burrow/pull/364, but the [wiki](https://github.com/linkedin/Burrow/wiki/Configuration) hasn't yet been updated. I ran into an issue where this configuration was helpful, and it took a while to figure out partly because the configuration wasn't in the wiki. It would be great if the wiki were updated to include the exhaustive list of configurations available to Burrow.

Contributor guide

No contributing guide indexed for this repository

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

Read the Configuration wiki page and pull request #364 first, then compare the documented entries with the notifier configurations introduced there. Update the wiki with the missing send-interval setting and the exhaustive configuration list, and verify that every available Burrow configuration is represented.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.