search

postalserver / docs

📚 Documentation for the Postal mail server!
https://docs.postalserver.io
135 stars 59 forks source link

Nuxt 3 migration #59

Closed casualmatt closed 4 months ago

casualmatt commented 4 months ago

[!WARNING]
👷‍♂️🚧 This PR is still a work in progress.

👨‍🔬 Preview URL

Use this URL to preview this PR:

What this PR does

This PR performs a major upgrade for Nuxt Content from v2 → v3, as discussed in the original issue: https://github.com/postalserver/docs/issues/58

Static Site Technical Details

Docs README

CI/CD

[!NOTE]
The CI/CD section may be deleted and replaced with Nuxt Studio (because Nuxt Studio has CI/CD built-in

  • [ ] Ensure all PRs have automated preview URLs
  • [ ] Production deployments should be automated with CI/CD from main as well
jaydrogers commented 4 months ago

Thanks for putting this together @casualmatt!

I updated your PR with some other todos that we'll need to check.

How do you feel on the GitHub Actions deployments? Looks like we'll need to get your Nuxt license loaded as a secret, but I might also have to factor some things for the automated PR previews.

Let me know what you need in order to help get this merged. Thanks a ton for your help!

casualmatt commented 4 months ago

@jaydrogers, there is no need for my license. Atinux from Nuxt has whitelisted the postalserver organization to use the OSS license.

When we merge the PR, we have to change some settings in the nuxt.config.ts

export default defineNuxtConfig({
  uiPro: { license: 'oss' }
})

If we notice any issues, I will ping him.

jaydrogers commented 4 months ago

@casualmatt Awesome!

What else do we need before we send this off to review. See my list in your original comment. Let me know what you need help with!

casualmatt commented 4 months ago

For now just waiting for feedback for the homepage from @adamcooke, we already talk and as soon as his finished with the big part of V3 he will take a look.

Did u have the time to download it and test it? If yes any suggestions/feedback?

I'm waiting for V3 to migrate to the new components/blocs because the content of the docs will be rewritten in part.

jaydrogers commented 4 months ago

Will take a look soon! It's on my list and I hopefully will have more time available later this week 👍

jaydrogers commented 4 months ago

@adamcooke & @willpower232:

Could you take a look at the preview of @casualmatt's great work on this? You can see the site here: https://casualmatt.github.io/postal-docs/

Matt did a fantastic job putting this together. The search works very well and the them matches postal very well too.

Next Steps

Any bugs or issues, just let us know in the comments below or you can open up individual issues and assign them to me. Thanks!

willpower232 commented 4 months ago

Looks great to me, might need a different landing page initially haha

casualmatt commented 4 months ago

Yes, But IDK what to place there, so if you have a list of 6 features to add, please let me know.

adamcooke commented 4 months ago

Thanks for all your work on this @casualmatt.

What are the next steps for getting this PR now merged so we can get it live on docs.postalserver.io? To start with, it would be good to get this published and then I'll add some more content about v3 once we've got that sorted.

  1. Do we need to update any config to handle publishing this to our domain instead of Matts?
  2. The GitHub Actions references a secret called secrets.NUXT_UI_PRO_LICENSE, do we need to add that to the main docs repo?
  3. Are there any other changes we need to make before making this live?
casualmatt commented 4 months ago
  1. Yes we need to remove the CI from nuxt.studio and add the classic GitHub pages for nuxt. Will do it tomorrow.
  2. No. we need to add a setting on the nuxt.config.ts: 
    export default defineNuxtConfig({
uiPro: { license: 'oss' }
})
  3. tomorrow I will do a global check.
adamcooke commented 4 months ago

Is there a reason to remove Nuxt Studio or can we just use that if it works?

casualmatt commented 4 months ago

Ready to merge.