Skip to content

refactor: upgrade to vuepress 2 #273

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

Merged
merged 9 commits into from
Aug 27, 2024
Merged

refactor: upgrade to vuepress 2 #273

merged 9 commits into from
Aug 27, 2024

Conversation

millnut
Copy link
Member

@millnut millnut commented Aug 24, 2024

What does this change?

  • Update Vuepress from v1 to v2
  • Update Node from 14 to 20 LTS, 14 is no longer supported
  • Update all core plugins and themes
  • Update to support new theming
  • Update child theme handling and to match the brand
  • Add .nvmrc to let netlify know which Node version we require
  • Update images path as image aliases are no longer available
  • Update search config
  • Fixes Fix security issues #190
  • Fixes Site title/logo is obscured on some screen widths #194 Update the navbar items so the search bar is visible between 1200px and 1350px

Copy link

netlify bot commented Aug 24, 2024

Deploy Preview for inspiring-euclid-d918c8 ready!

Name Link
🔨 Latest commit 7e727aa
🔍 Latest deploy log https://app.netlify.com/sites/inspiring-euclid-d918c8/deploys/66cc7c6243f9a30007fc23a3
😎 Deploy Preview https://deploy-preview-273--inspiring-euclid-d918c8.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@millnut
Copy link
Member Author

millnut commented Aug 24, 2024

Hi @stephen-cox this is still in progress while I look at Algolia integration however the preview fails due to using Node 16.

Can the node version for preview environments be updated to Node 20?

Ignore looking at netlify, I can control this via a .nvmrc file

@@ -84,9 +84,6 @@ The preheader region appears before the header. It shows the sitewide search if
- Constrained content and full width background: the content is constrained to the width of the page, while the background is full width
- Constrained content and background: both the background and content are constrained and centered

![Illustration showing the three options described above.](/microsites/images/preheaderWidth.png)
Copy link
Member Author

Choose a reason for hiding this comment

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

This image does not exist so I removed this line as it was causing the build to fail

@millnut millnut changed the title [wip] refactor: initial upgrade to vuepress 2 refactor: upgrade to vuepress 2 Aug 25, 2024
@millnut millnut marked this pull request as ready for review August 25, 2024 10:38
@markconroy markconroy self-requested a review August 26, 2024 11:23
Copy link
Member

@markconroy markconroy left a comment

Choose a reason for hiding this comment

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

FAAAAANTASTIC!

Thanks so much for all this work @millnut


Thanks to Big Blue Door for sponsoring my time to work on this.

@markconroy
Copy link
Member

One issue we have is on large screens, the search bar is not visible between 1200px and 1350px, but let's get this deployed first and we can create a follow up issue for that (unless you want to fix it before we deploy).

@millnut
Copy link
Member Author

millnut commented Aug 26, 2024

One issue we have is on large screens, the search bar is not visible between 1200px and 1350px, but let's get this deployed first and we can create a follow up issue for that (unless you want to fix it before we deploy).

Yep let me take a look at that before merging, I'll update here once I've taken a look

@millnut
Copy link
Member Author

millnut commented Aug 26, 2024

Hi @markconroy I've taken a look at this and the best way is going to be refactoring the navbar items to dropdowns, I've refactored the navbar items into groups with enough space for us to create a Modules or Ecosystem dropdown in future to allow more detail module documentation

@millnut millnut mentioned this pull request Aug 26, 2024
@markconroy
Copy link
Member

markconroy commented Aug 26, 2024

Another approach would be to never have a desktop navigation, and always use the mobile/hamburger approach no matter how wide the screen is.

What you have done with the dropdown menus looks great. Let's try get this merged at Merge Tuesday tomorrow.

@finnlewis finnlewis merged commit c3f5f2e into main Aug 27, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Site title/logo is obscured on some screen widths Fix security issues
3 participants