Docs site uses an old version of jquery

[martinohanlon]

This PR (#468) was recently progressed to upgrade the version of jquery from 1.12.4 to 3.6.4.

At the time the change was pushed to master but the docs werent rebuilt. I have just tried to rebuild the docs and the change to jquery stops features like navigation working.

The jquery library is part of the cinder mkdocs theme (https://github.com/chrissimpkins/cinder) hasnt seen an update for 3 years and no recent activity.

Options seem to be:

• revert the change and go back to an old version of jquery and the potential security issue
• change the theme to a different and supported theme
• upgrade jquery and try and fix the cinder issues (and then push upstream to cinder)

I would suggest reverting the change right now (as we can build docs at the moment) and looking for another theme.

@lawsie - thoughts?

[martinohanlon]

Raised issue with the cinder project - chrissimpkins/cinder#110

[martinohanlon]

If we decided to move to a new theme, the bootswatch project has a lot of good options.

Personally I like litera

[lawsie]

I don’t mind moving, as long as it maintains friendliness. When I get a moment I’ll have a look at those 😁 I guess we probably want to move to something that is maintained actively to avoid having to move yet again!

…

On Fri, 14 Jul 2023 at 08:35, martinohanlon ***@***.***> wrote: If we decided to move to a new theme, the bootswatch <https://bootswatch.com/> project has a lot of good options. Personally I like litera <https://bootswatch.com/litera/> — Reply to this email directly, view it on GitHub <#477 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABHRRUIMAHOG4TCEXZYAUALXQDZDVANCNFSM6AAAAAA2GHBYCQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[martinohanlon]

we probably want to move to
something that is maintained actively to avoid having to move yet again!

Yep, the bootstrap and bootswatch are the 2 noted on mkdocs and look to be well supported.

Suggest we back out the jQuery update so we can push changes and create a new branch where we can assess new mkdocs themes.

[martinohanlon]

I have backed out the jquery and done a release of the documentation

[lawsie]

Just had a look and I prefer Quartz. (Just kidding, litera looks perfect...) - I'll have a play.

[martinohanlon]

Resolved with PR #481

[martinohanlon]

Resolved.