Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Storybook, cleanups #860

Merged
merged 3 commits into from
Jan 12, 2024
Merged

Remove Storybook, cleanups #860

merged 3 commits into from
Jan 12, 2024

Conversation

HarelM
Copy link
Member

@HarelM HarelM commented Jan 11, 2024

  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
Copy link
Member

nyurik commented Jan 11, 2024

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

@HarelM
Copy link
Member Author

HarelM commented Jan 11, 2024

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
Copy link
Member

nyurik commented Jan 11, 2024

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
Copy link
Member Author

HarelM commented Jan 12, 2024

Can I merge this?

@nyurik
Copy link
Member

nyurik commented Jan 12, 2024

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
Copy link
Member Author

HarelM commented Jan 12, 2024

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

Copy link
Member

@nyurik nyurik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! feel free to merge

@nyurik nyurik changed the title Clean up Remove Storybook, cleanups Jan 12, 2024
@HarelM HarelM merged commit a62db14 into main Jan 12, 2024
7 checks passed
@HarelM HarelM deleted the clean-up branch January 12, 2024 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants