search

maplibre / maputnik

An open source visual editor for the 'MapLibre Style Specification'
https://www.maplibre.org/maputnik
MIT License
2.14k stars 402 forks source link

Remove Storybook, cleanups #860

Closed HarelM closed 10 months ago

HarelM commented 10 months ago
  1. Changed references to point to this new repo
  2. Fixed docker image publishing to point to ghcr.io.
  3. Remove survey link - the survey is closed and there's no point in keeping it.
  4. Remove storybook - Basically a storybook is the ability to look at components and see how they look and interact with them. It's a powerful tool for developing component library with "live" documentation. But it's an overkill for this project and I would like to reduce maintenance costs. Currently all the "stories" are in javascript and not in typescript and it feels like a waste of time to try and maintain it, along with updating the storybook library itself and everything around it.
nyurik commented 10 months ago

@HarelM could you clarify what is the storybook and why we don't need it?

HarelM commented 10 months ago

It's mentioned in the channel. Basically a storybook is the ability to look at components and see how they look and interact with them. It's a powerful tool for developing component library with "live" documentation. But it's an overkill for this project and I would like to reduce maintenance costs. Currently all the "stories" are in javascript and not in typescript and it feels like a waste for me to try and maintain it, along with updating the storybook library itself and everything around it.

nyurik commented 10 months ago

Thx for explanation. We should not rely on Slack channels to document our changes to the code, so lets make sure each change has clear explanation in the top comment of why it is being done - most people will have no idea there was a channel discussion when looking in the history of the project

HarelM commented 10 months ago

Can I merge this?

nyurik commented 10 months ago

Please update the first comment with the in-depth explanation of this change, and why it is not needed. This way that comment will go into the code's history, and can be easily viewed by anyone using git blame / viewing git log messages

HarelM commented 10 months ago

Updated the initial post. Please squash and merge if this is good enough.