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

docs: add Sass deprecations notice in docs #41283

Merged
merged 7 commits into from
Apr 7, 2025

Conversation

MaxLardenois
Copy link
Contributor

@MaxLardenois MaxLardenois commented Mar 10, 2025

Description

This PR will add a callout in the docs to explain and provide links to potential resolution regarding Sass depreciation. Also it modifies Vite, Parcel and Webpack configs to silence the deprecations warnings from Dart Sass.

Motivation & Context

Many issues are opened regarding the Sass deprecation notices (see #40962) and users must search the web to pinpoint the problem and potential workarounds, adding a callout directly in the docs while the core team is working on node Sass exit would be helpful for users and would limit erroneous new issues opening about these deprecations.
We have the same problems with our company's fork's users who must search the web for information about these issues but we figured it could be an improvement on Bootstrap docs directly.

Type of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (non-breaking change)
  • Breaking change (fix or feature that would change existing functionality)

Checklist

  • I have read the contributing guidelines
  • My code follows the code style of the project (using npm run lint)
  • My change introduces changes to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

Live previews

Related issues

#40962

@MaxLardenois MaxLardenois marked this pull request as ready for review March 10, 2025 09:21
@julien-deramond
Copy link
Member

Thanks for this PR, @MaxLardenois!
I haven’t reviewed the exact wording and modifications in detail, but I’m not opposed to adding it temporarily to our documentation. However, we need to carefully coordinate the merge of this PR with our upcoming releases.
If we want this change to be useful in time, it should be included in v5.3.4. Additionally, if this is merged, we’ll need to update twbs/examples accordingly.
@mdo, what do you think? Should I help move this PR forward?

Copy link
Member

@mdo mdo left a comment

Choose a reason for hiding this comment

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

Some edits that I'll accept after posting this.

@mdo mdo added this to v5.3.6 Apr 6, 2025
@github-project-automation github-project-automation bot moved this to To do in v5.3.6 Apr 6, 2025
@mdo mdo force-pushed the sass-deprecation-doc branch from c7f6ecc to 98ff8c2 Compare April 6, 2025 20:35
@julien-deramond julien-deramond moved this from To do to Review in progress in v5.3.6 Apr 7, 2025
@julien-deramond julien-deramond self-requested a review April 7, 2025 18:13
Copy link
Member

@julien-deramond julien-deramond left a comment

Choose a reason for hiding this comment

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

Thanks again for the PR! I fixed the cspell error, aligned the new comments for consistency, and adjusted the step in the Parcel guide so that the file is added only when needed. For the other two guides, they’re easier to explain once the config is in place.

Once this PR is merged, I’ll:

  • open a PR in twbs/examples to apply these changes
  • update my "Drop Node Sass" PR to consider removing these changes from both the documentation and twbs/examples

@julien-deramond julien-deramond moved this from Review in progress to Ready to merge in v5.3.6 Apr 7, 2025
@julien-deramond julien-deramond merged commit 6f10a1e into twbs:main Apr 7, 2025
13 checks passed
@github-project-automation github-project-automation bot moved this from Ready to merge to Done in v5.3.6 Apr 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants