stackabletech / stackabletech/demos

docs: rename demos and make them more use case oriented

Open
#16 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
3
Forks
13
Avg merge
2d 20h
Merged PRs (30d)
2

Description

Currently the demos are named based on the tech that is used in them. This is good if you're a potential user that already has a Stack of tools that you want to migrate, or if you already have a deeper technical understanding of the tools you might need.

I would propose that we instead rename i.e. nifi-kafka-druid-water-level-data to "Real time stream data analysis and visualization" or something like that. Less focus on the tools and this particular dataset (water levels) and more on the general problem it solves. This way it is more interesting to people that might not know this specific stack, but also to people that might have an existing pipeline that does just this, but maybe with different tools. They might still be interested in using stackable and also swapping out some of their tools in their pipeline while they are at it.

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

The issue names no files or tests, so first locate the demos and the entry for nifi-kafka-druid-water-level-data. Review the current demo names against the proposed use-case-oriented naming, then rename the relevant demos consistently. Done means the names emphasize the general problem rather than the tools or dataset.

Written by the indexing model from the issue text.

Assessment

Tech stack
kafka
Domain
content, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.