influxdata / influxdata/kapacitor

Document each node and chain method with explicit data examples

Open
#1,636 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
2.4k
Forks
479
Avg merge
4d 16h
Merged PRs (30d)
4

Description

It would be extremely useful if the documentation for each Kapacitor node and chain method included explicit example input data and the resulting output data in Influx line format or tabular format. Sometimes it's not very clear from the documentation what the result of applying a given method or node would be just from reading the description.

For example, the [join node](https://docs.influxdata.com/kapacitor/v1.3/nodes/join_node/) might have a blurb like:

# Inputs

## Measurement ``error``

```
time value
---- ------
1508860350607742142 10
1508860351607742142 11
```

## Measurement ``requests``

```
time value
---- ------
1508860350607742142 12
1508860351607742142 13
```

# Outputs

```
time error.value requests.value
---- ----------- --------------
1508860350607742142 10 12
1508860351607742142 11 13
```

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

Start with the join node documentation page linked in the issue and review how node and chain method pages are organized. Inventory the relevant documentation pages, then add explicit input and output examples in Influx line or tabular format for each. The work is done when every node and chain method has an example that makes its resulting data clear.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.