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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Remove uncessary components #25228

Closed
wants to merge 1 commit into from

Conversation

jonniebigodes
Copy link
Contributor

Closes #

What I did

With this pull request, the documentation was updated to remove some one-off components (i.e., FrameworkSupportTable, FeatureSnippets) to streamline the documentation workflow.

What was done:

  • Removed mentioned components.
  • Removed the associated MDX-based files
  • Polished and restructured the documentation to include the information and conditionally rendered it.
  • Created required snippets

@cdedreuille , with this change, we're good to go on removing the components already mentioned and adjusting the components that depend on the frameworks.js as the featureGroups object is no longer in effect the information was converted into a Markdown table.

Checklist for Contributors

Testing

  1. Follow the steps in the contributing instructions for this branch, docs_remove_feature_snippet.
  2. Open the relevant documentation and verify the feature changes.

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

馃 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels Dec 14, 2023
@jonniebigodes jonniebigodes self-assigned this Dec 14, 2023
@cdedreuille
Copy link
Contributor

That's great @jonniebigodes. If we remove the component, will it have an impact on previous versions?

@jonniebigodes
Copy link
Contributor Author

@cdedreuille it probably does with the previous versions of documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants