splunk / splunk/stef

Find better "hello world" example

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

Nobody has claimed this yet.

Dominant language
Java
Stars
11
Forks
6
Avg merge
55m
Merged PRs (30d)
1

Description

The first example we show on https://www.stefdata.net/ is using JSON like data. This is the worst possible use case for STEF. We need a better example that uses a strongly-typed schema that demonstrates the benefits better.

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 at the first example on https://www.stefdata.net/ and review how it currently uses JSON-like data. Replace it with an example using a strongly typed schema that makes STEF's benefits clear; done means the opening example no longer demonstrates the stated worst use case.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.