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 warning callout for Yarn Berry #41036

Merged
merged 2 commits into from
Nov 22, 2024

Conversation

julien-deramond
Copy link
Member

@julien-deramond julien-deramond commented Nov 17, 2024

Description

Based on the discussion in #40933 and the solution brought to build our Sass & JS example in #40933 (comment), this PR suggests a small enhancement to at leasts mention this "trick".

The approach is that we consider that most folks are still on Yarn (Classic), but we mention a way to make our examples work with Yarn Berry too to unblock some others.

Another approach would be to create a dedicated example in twbs/examples and link to it. But, TBH, I don't have time for it, and I'm not sure whether it's needed for now.

Type of changes

  • Docs enhancement

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
  • (N/A) I have added tests to cover my changes
  • All new and existing tests passed

Live previews

@julien-deramond julien-deramond marked this pull request as ready for review November 17, 2024 18:30
@julien-deramond julien-deramond force-pushed the main-jd-add-warning-callout-for-yarn-berry branch from 62ed3e2 to 5ff09a8 Compare November 17, 2024 18:31
Copy link
Member

@louismaximepiton louismaximepiton left a comment

Choose a reason for hiding this comment

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

The rendering looks a bit weird. Maybe we should remove the .bd-callout .highlight rule.
On the content, I tried and it works pretty well, I'm just wondering where it should be placed tbh. Maybe inside the ## Examples paragraph ? It looks weird in here since we only mention the library.

@julien-deramond
Copy link
Member Author

On the content, I tried and it works pretty well, I'm just wondering where it should be placed tbh. Maybe inside the ## Examples paragraph ? It looks weird in here since we only mention the library.

I chose this place because this is the only place where "Yarn" is mentioned. So I'd suppose that Yarn users would end up here at some point.

The rendering looks a bit weird

You mean the code part within the warning callout? FYI, we got the same rendering at https://deploy-preview-41036--twbs-bootstrap.netlify.app/docs/5.3/components/tooltips/#usage

@julien-deramond julien-deramond merged commit ec96eac into main Nov 22, 2024
14 checks passed
@julien-deramond julien-deramond deleted the main-jd-add-warning-callout-for-yarn-berry branch November 22, 2024 09:54
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.

2 participants