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

Rename .storybook folder to have no dots in the prefix #10090

Open
2 tasks
eugene-manuilov opened this issue Jan 21, 2025 · 4 comments
Open
2 tasks

Rename .storybook folder to have no dots in the prefix #10090

eugene-manuilov opened this issue Jan 21, 2025 · 4 comments
Assignees
Labels
Next Up Issues to prioritize for definition P2 Low priority Team M Issues for Squad 2 Type: Infrastructure Engineering infrastructure & tooling

Comments

@eugene-manuilov
Copy link
Collaborator

eugene-manuilov commented Jan 21, 2025

Feature Description

In order to prepare storybook dependencies to migrated into their own workspace, we need to rename the main folder we use for the storybook setup. This is needed because we can't use workspaces that start with dots. So, ideally, we need to rename .storybook to be just storybook.


Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

  • The .storybook folder is renamed to storybook.
  • All references to the .storybook folder in our codebase (if we have any) are updated to point to the new folder.

Implementation Brief

  • Rename the .storybook folder to storybook.
  • Update the following files that currently reference the no renamed .storybook/:
    • .eslintignore
    • package.json
    • .github/workflows/storybook.yml
    • .github/workflows/visual-regression.yml
    • .storybook/webpack.config.js
    • .vscode/settings.json
    • assets/js/components/adminbar/common-GA4.stories.js
    • assets/js/components/OverlayNotification/AnalyticsAndAdSenseAccountsDetectedAsLinkedOverlayNotification.test.js
    • assets/js/components/settings/SettingsAdmin.stories.js
    • assets/js/components/wp-dashboard/common-GA4.stories.js
    • assets/js/modules/adsense/components/dashboard/DashboardTopEarningPagesWidgetGA4.stories.js
    • assets/js/modules/adsense/components/module/ModuleOverviewWidget/index.stories.js
    • assets/js/modules/adsense/components/widgets/TopEarningContentWidget.stories.js
    • assets/js/modules/analytics-4/components/dashboard/DashboardOverallPageMetricsWidgetGA4.stories.js
    • assets/js/modules/analytics-4/components/dashboard/DashboardAllTrafficWidgetGA4/indexEntityDashboard.stories.js
    • assets/js/modules/analytics-4/components/dashboard/DashboardAllTrafficWidgetGA4/indexMainDashboard.stories.js
    • assets/js/modules/analytics-4/components/module/ModulePopularPagesWidgetGA4/index.stories.js
    • assets/js/modules/analytics-4/components/widgets/EngagedTrafficSourceWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/LeastEngagingPagesWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/MostEngagingPagesWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/NewVisitorsWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/PagesPerVisitWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/PopularAuthorsWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/PopularContentWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/PopularProductsWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/ReturningVisitorsWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopCategoriesWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopCitiesDrivingAddToCartWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopCitiesDrivingLeadsWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopCitiesDrivingPurchasesWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopCitiesWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopConvertingTrafficSourceWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopCountriesWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopDeviceDrivingPurchasesWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopPagesDrivingLeadsWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopRecentTrendingPagesWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopReturningVisitorPages.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopTrafficSourceDrivingAddToCartWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopTrafficSourceDrivingLeadsWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopTrafficSourceDrivingPurchasesWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/TopTrafficSourceWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/VisitLengthWidget.stories.js
    • assets/js/modules/analytics-4/components/widgets/VisitsPerVisitorWidget.stories.js
    • assets/js/modules/search-console/components/dashboard/DashboardPopularKeywordsWidget.stories.js
    • tests/backstop/scenarios.js

Test Coverage

  • No additional test coverage required, ensure all existing tests pass and the backstop tests run.

QA Brief

Changelog entry

@eugene-manuilov eugene-manuilov added P2 Low priority Type: Infrastructure Engineering infrastructure & tooling labels Jan 21, 2025
@ankitrox ankitrox self-assigned this Jan 22, 2025
@aaemnnosttv
Copy link
Collaborator

@eugene-manuilov wouldn't the storybook config go into the root of a new workspace for Storybook under the same name?

@ankitrox ankitrox assigned eugene-manuilov and unassigned ankitrox Jan 23, 2025
@eugene-manuilov
Copy link
Collaborator Author

@aaemnnosttv, yes, good point, but that should happen in #10091

@eugene-manuilov eugene-manuilov removed their assignment Jan 26, 2025
@ivonac4 ivonac4 added Team M Issues for Squad 2 Next Up Issues to prioritize for definition labels Jan 31, 2025
@benbowler benbowler assigned benbowler and unassigned benbowler Jan 31, 2025
@aaemnnosttv
Copy link
Collaborator

@eugene-manuilov what I meant was, this change doesn't seem necessary if we are putting this into the new workspace rather than trying to make it the workspace itself. Could we not create storybook to be the new workspace while keeping the SB "root"/config directory the same for now to avoid making all these changes or are they all really needed?

@eugene-manuilov
Copy link
Collaborator Author

Not sure what you suggest, @aaemnnosttv. We have some storybook dependencies (one of which is puppeteer iirc) that would be nice to move to its own workspace. Do you suggest not creating a workspace for storybook and leave them in the main package.json file?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Next Up Issues to prioritize for definition P2 Low priority Team M Issues for Squad 2 Type: Infrastructure Engineering infrastructure & tooling
Projects
None yet
Development

No branches or pull requests

5 participants