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: replace twbs/bootstrap-npm-starter by twbs/examples/tree/main/icons-font #37671

Merged
merged 6 commits into from
Jan 4, 2023

Conversation

julien-deramond
Copy link
Member

@julien-deramond julien-deramond commented Dec 19, 2022

Bootstrap 4 is EOL in few weeks.
It means that https://github.com/twbs/bootstrap-npm-starter shouldn't be referenced anymore in our latest documentation. And that it could probably by archived.

This PR suggested that all references to https://github.com/twbs/bootstrap-npm-starter are changed to use the closest already existing example we have... and it seems to be https://github.com/twbs/examples/tree/main/icons-font.

This PR also suggest to update the Starter template example page to add references to our other examples.

This version tries not to modify too much wording and references by keeping the notion of "npm started" even if our example is rather named "Bootstrap Icons", but we can go further.
/cc @mdo

Type of changes

  • Refactoring (non-breaking change)

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
  • All new and existing tests passed

Live previews

@julien-deramond julien-deramond marked this pull request as ready for review December 19, 2022 21:26
@julien-deramond julien-deramond changed the title Docs: replace twbs/bootstrap-npm-starter by twbs/examples/tree/main/icons-font Docs: replace twbs/bootstrap-npm-starter by twbs/examples/tree/main/icons-font Dec 19, 2022
@mdo
Copy link
Member

mdo commented Dec 24, 2022

I think https://github.com/twbs/examples/tree/main/sass-js or https://github.com/twbs/examples/tree/main/sass-js-esm is a better fit here instead of the Icons example which doesn't compile Bootstrap's source Sass code at all. Thoughts?

@julien-deramond
Copy link
Member Author

I can replace in this PR https://github.com/twbs/examples/tree/main/icons-font with https://github.com/twbs/examples/tree/main/sass-js as suggested and in a second time recreate the starter template in https://github.com/twbs/examples which is mayble more complete?

@mdo mdo force-pushed the main-jd-replace-npm-starter branch from 6ce7485 to 58ab6bf Compare January 4, 2023 04:30
@mdo mdo requested a review from a team as a code owner January 4, 2023 04:30
@mdo
Copy link
Member

mdo commented Jan 4, 2023

Updated it to replace the links as mentioned. Also updated the starter template's CSS, so this is now dependent on the icon link addition, and fixes the .text-dark instance. Once that merges, this can merge.

@mdo mdo force-pushed the main-jd-replace-npm-starter branch from 58ab6bf to 4353a07 Compare January 4, 2023 06:24
@mdo mdo force-pushed the main-jd-replace-npm-starter branch from 4353a07 to 9649f86 Compare January 4, 2023 17:58
@mdo mdo merged commit 8a35408 into main Jan 4, 2023
@mdo mdo deleted the main-jd-replace-npm-starter branch January 4, 2023 21:38
@mahilanmjd mahilanmjd mentioned this pull request Apr 16, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants