docsy icon indicating copy to clipboard operation
docsy copied to clipboard

Published 20 hours ago • verified publisher icon google

Upgrade to Bootstrap 5

Open LisaFC opened this issue 3 years ago • 7 comments

Bootstrap 5 has some changes that seem to break Docsy site builds #304 #464.

(Edit: @chalin)

Tasks:

  • [ ] Drop jQuery
  • [ ] Upgrade to Popper v2
  • [ ] Drop current custom RTL solution and adopt Bootstrap's solution
  • [ ] Update CHANGELOG
  • [ ] static/css/swagger-ui.css will need updates

Specific changes (to be) applied

Utilities:

  • Rename .ml-* and .mr-* to .ms-* and .me-*.

LisaFC avatar Mar 02 '21 11:03 LisaFC

Suggestion: Use Tailwind CSS instead. 😄

bwklein avatar Mar 17 '21 23:03 bwklein

Is not Docsy only, its all themes..., is all..., in netlify

kinti avatar Mar 21 '21 22:03 kinti

Hmm, didn't realize how many things it wasn't compatible with. :( I'll see if I can find any more general Hugo/Netlify bootstrap 5 issues.

LisaFC avatar Mar 29 '21 15:03 LisaFC

I took a look, and after bumping bootstrap from v4-dev to main, I was able to replicate the issues others had found with errors, and found it was related to color-yiq being renamed... which was already found in https://github.com/google/docsy/pull/517 :)

As they found, there are other small UX differences that are visible just in the user guide. See a dynamic view of the 517 Netlify preview for comparison

The Bootstrap migration guide should help with a lot of these https://getbootstrap.com/docs/5.0/migration/.

I'm not 100% across this project, testing wise, how you enumerate all the customisations your theme has, etc.

glasnt avatar Dec 07 '21 02:12 glasnt

Extra incentive to schedule migration to v5 before year's end:

  • v4 critical support ends: 2022/11
  • v4 EOL: 2023/01

Sources:

  • https://blog.getbootstrap.com/2022/07/19/bootstrap-4-6-2/
  • https://endoflife.date/bootstrap

/cc @geriom @emckean

chalin avatar Jul 20 '22 12:07 chalin

Name changed so we can use this to track actually making the necessary update.

LisaFC avatar Aug 18 '22 15:08 LisaFC

Thanks @LisaFC. FYI, I've set the milestone to Q3 :).

chalin avatar Aug 18 '22 15:08 chalin

Moved to 22Q4. Given the deadlines we're facing re. BS v4 EOL, we really should schedule this work to happen soon:

Extra incentive to schedule migration to v5 before year's end:

  • v4 critical support ends: 2022/11
  • v4 EOL: 2023/01

chalin avatar Oct 08 '22 14:10 chalin

I've updated the title to reflect that this is an upgrade to v5 that stops at 5.2. I was hoping to pickup 5.3, but it is still in alpha, and I don't want to delay a release of Docsy any longer.

Other updates make to this issue:

  • Forms-migration requirements checks have been completed
  • Card-pane update rebased, conflict-resolved and merged - #1376

I've created a followup meta issue to track the key changes we'll want to make after this issue is closed:

  • #1510

chalin avatar May 04 '23 15:05 chalin