#38 18.OP-1 - KPI JSON

Open
opened 3 years ago by l1dev · 1 comments
l1dev commented 3 years ago

$300

https://blog.joystream.org/sumer-kpis/#18.OP-1

As many have pointed out, using this blog post to read the KPIs is cumbersome at best. The Operations group has proposed a new format for this, under the assumption we still used a JSON to present the data. As this is, sadly, not the case anymore, we need to make it happen!

Note that the Operations Lead proposed using YAML instead of a JSON, but I prefer the latter for the simple fact that it's used in so many other parts of the Joystream Platform, making it easier for most to grasp (if not master).

  1. Based on the structure of this, and previous KPIs, come up with a JSON Schema for presenting the data in the KPIs.

  2. Find a "clever" standard of presenting tables, line changes, bullet points (and numbered/lettered) presented.

  3. Create a script that parses a markdown and creates a nice looking JSON, OR vice-versa.

Files

Parsers

JSON Schema

*$300* https://blog.joystream.org/sumer-kpis/#18.OP-1 > As many have pointed out, using this blog post to read the KPIs is cumbersome at best. The Operations group has proposed a new format for this, under the assumption we still used a JSON to present the data. As this is, sadly, not the case anymore, we need to make it happen! > > Note that the Operations Lead proposed using YAML instead of a JSON, but I prefer the latter for the simple fact that it's used in so many other parts of the Joystream Platform, making it easier for most to grasp (if not master). 1. Based on the structure of this, and previous KPIs, come up with a JSON Schema for presenting the data in the KPIs. 2. Find a "clever" standard of presenting tables, line changes, bullet points (and numbered/lettered) presented. 3. Create a script that parses a markdown and creates a nice looking JSON, OR vice-versa. # Files - [kpi-17.md](https://cdn.discordapp.com/attachments/812343783504085062/876132732504256542/kpi-17.md) # Parsers - [markdown](https://github.com/sparkartgroup/gulp-markdown-to-json) # JSON Schema - isonar proposed this [schema]( https://github.com/Joystream/community-repo/pull/303) ([howto json schema](https://www.tutorialspoint.com/json/json_schema.htm)) - target format: [ghost markdown](https://ghost.org/help/using-markdown)
isonar commented 3 years ago
Collaborator

How about deprecating the single-huge-page KPI representation? I've filed a Bounty proposal to design a better UI for that: https://github.com/Joystream/community-repo/issues/280

If this idea is given green light, the backend would be needed as well, plus a primitive admin UI to enter new KPIs data. Script to convert markdown to json and vice versa kinda doesn't fit into this brave new world. Martin would simply log in into the admin UI and enter all the needed data :))

How about deprecating the single-huge-page KPI representation? I've filed a Bounty proposal to design a better UI for that: https://github.com/Joystream/community-repo/issues/280 If this idea is given green light, the backend would be needed as well, plus a primitive admin UI to enter new KPIs data. Script to convert markdown to json and vice versa kinda doesn't fit into this brave new world. Martin would simply log in into the admin UI and enter all the needed data :))
Sign in to join this conversation.
No Milestone
No assignee
2 Participants
Loading...
Cancel
Save
There is no content yet.