influxdata / influxdata/giraffe

Docs: Add deeper getting started docs, to be done after quickstart

Open
#326 0 comments 0 reactions 0 assignees View on GitHub
team/ui
Dominant language
TypeScript
Stars
189
Forks
33
Avg merge
3d 15h
Merged PRs (30d)
4

Description

### Background
Currently the docs have a small quickstart section followed by a couple of sections of helpful functions, and then function argument documentation.

We want to hold user's hands a little bit longer through the process than we currently do.

Some things to consider including:
- the different types of graphs to draw
- how to draw them
- how to connect giraffe to your data
- how to integrate giraffe with redux

### Acceptance Criteria
- After the quickstart, the docs explain how to deeply integrate Giraffe using npm/yarn and react

Contributor guide

Open the contributing guide

Research direction

Start by locating the documentation's quickstart and the sections that follow it. Extend the getting-started path to cover graph types, connecting Giraffe to data, Redux integration, and npm/yarn use with React; done when the documentation explains deeper integration after the quickstart.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, redux, typescript
Domain
documentation, frontend
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 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.