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

chore: update current docus deployments #303

Open
Tracked by #520
pi0 opened this issue May 12, 2021 · 19 comments
Open
Tracked by #520

chore: update current docus deployments #303

pi0 opened this issue May 12, 2021 · 19 comments
Assignees
Labels

Comments

@pi0
Copy link
Contributor

pi0 commented May 12, 2021

This is a list to keep an eye on projects currently use Docus (feel free to edit message):

Repo URL Tree Docus version PR Open
nuxt/http https://http.nuxtjs.org/ https://github.com/nuxt/http/tree/master/docs ^1.1.3
nuxt/image https://image.nuxtjs.org/ https://github.com/nuxt/image/tree/main/docs ^1.1.3
nuxt/content https://content.nuxtjs.org/ https://github.com/nuxt/content/tree/main/docs ^1.1.3
nuxt-modules/i18n https://i18n.nuxtjs.org/ https://github.com/nuxt-modules/i18n/tree/master/docs ^1.1.3
nuxt-modules/apollo https://apollo.nuxtjs.org/ https://github.com/nuxt-modules/apollo/tree/master/docs ^1.1.3
nuxt-modules/tailwindcss https://tailwindcss.nuxtjs.org/ https://github.com/nuxt-modules/tailwindcss/tree/main/docs ^1.1.3
nuxt-modules/sanity https://sanity.nuxtjs.org/ https://github.com/nuxt-modules/sanity ^1.1.3
nuxt-modules/strapi https://strapi.nuxtjs.org/ https://github.com/nuxt-modules/strapi ^1.1.3
nuxt-modules/color-mode  https://color-mode.nuxtjs.org/ https://github.com/nuxt-community/color-mode-module ^1.1.3
nuxt-community/ackee-module https://ackee.nuxtjs.org https://github.com/nuxt-community/ackee-module ^1.1.3
unjs/nitro https://nitro.unjs.io https://github.com/unjs/nitro ^1.1.3
nuxt-community/strapi-module https://strapi.nuxtjs.org/ https://github.com/nuxt-community/strapi-module ^0.5.14
nuxt-community/composition-api https://composition-api.nuxtjs.org/ https://github.com/nuxt-community/composition-api ^0.5.6
danielroe/typed-vuex https://typed-vuex.roe.dev/ https://github.com/danielroe/typed-vuex ^0.5.6
@Tahul
Copy link
Contributor

Tahul commented May 12, 2021

Thank you a lot @pi0 🙏

@atinux atinux added the info label May 12, 2021
@Tahul
Copy link
Contributor

Tahul commented May 19, 2021

For @nuxt/image:
nuxt/image#282

For @nuxtjs/composition-api:
nuxt-community/composition-api#485

@Tahul
Copy link
Contributor

Tahul commented May 19, 2021

For @nuxt/http:
nuxt/http#180

@Tahul
Copy link
Contributor

Tahul commented May 20, 2021

For @nuxt/vite:
nuxt/vite#145

@Tahul
Copy link
Contributor

Tahul commented May 20, 2021

For nuxt-community/tailwindcss-module:
nuxt-modules/tailwindcss#352

@Tahul
Copy link
Contributor

Tahul commented May 20, 2021

For nuxt-community/sanity-module:
nuxt-modules/sanity#149

@Tahul
Copy link
Contributor

Tahul commented May 20, 2021

For danielroe/typed-vuex:
danielroe/typed-vuex#235

Copy link
Contributor

atinux commented May 24, 2021

Updated to add nuxt-community/ackee-module

@Tahul Tahul changed the title Current docus deployments chore: update current docus deployments May 24, 2021
Copy link
Contributor

Tahul commented May 24, 2021

Hey 👋

Thanks @atinux ;

I've also updated it to add nuxt-community/color-mode-module 😄

Will be updating them once I'm done with the documentation update

Copy link
Contributor

atinux commented May 26, 2021

Added https://github.com/nuxt-community/strapi-module to the list, cc @benjamincanac he had an issue with it.

@Tahul Tahul mentioned this issue Jun 29, 2021
17 tasks
Copy link
Contributor

atinux commented Nov 24, 2022

We should track the update of Docus now for all of these websites.

@Tahul
Copy link
Contributor

Tahul commented Nov 27, 2022

@atinux ; can we add Docus to Vue Telescope somehow?

I would love to have a complete list so I can process all these updates in a batch.

Updating from latest Tailwind version to ^1.0.0 isstraightforward andrepetitive so I would like to process this all at once.

@Tahul
Copy link
Contributor

Tahul commented Dec 7, 2022


cc: @atinux @pi0 @danielroe ;

I suggest that we deprecate vite.nuxtjs.org and composition-api.nuxtjs.org to redirect the trafic towards nuxt.com documentation pages about @nuxt/bridge.

If you want to preserve these sites, I'll send a PR upgrading them as well.

cc: @danielroe ;

Do you want me to upgrade typed-vuex docs too? :)


Now that Docus is open source, I would love to maintain a "is using" list.

I'll add all these repositories on readme.md, and would love anyone from you that knows someone using Docus to be pinged here: #713 👁️

Copy link
Collaborator

You are a total star. I think we're not ready to deprecate composition-api.nuxtjs.org but I think we should be able to do that for vite.nuxtjs.org - (what do you think @pi0?).

As for typed-vuex, I would be very grateful but am also happy to do it; I'll happily follow the example of any migrations you do elsewhere.

@Tahul
Copy link
Contributor

Tahul commented Dec 7, 2022

@danielroe thank you so much ❤️

I'll do it for typed-vuex and composition-api then :), that is fine for me to do it, as long as it helps me to write the upcoming "migrating" section of docs, even for very old Docus/nuxt-content-theme-docs setups.

I have another small question for you, some of these repositories seem to have an issue booting, defineAppConfig and other auto-imports seem to be undefined.

I was unable to track what is the root cause for this, some contextuals factors are the exact same between one repository that works, and the others that don't.

  • Same Nuxt / Docus versions
  • Same package manager (yarn)
  • Same setup (module at src/, docs in docs/)
  • Same nuxt.config

I suspect it might be coming from a local factor (my laptop/Node setup?), but maybe you've already heard of that before?

Anyways, expect the PRs for remaining repositories soon. 😄

@danielroe
Copy link
Collaborator

Likely those repos have explicitly disabled imports.autoImport in .nuxtrc, to prevent issues with runtime files not explicitly importing their auto imports. I'll think about the best way of handling this, but overriding this in docs project seems best.

Copy link
Contributor

atinux commented Dec 7, 2022

@Tahul Tahul closed this as completed Feb 22, 2023
@Tahul
Copy link
Contributor

Tahul commented Jun 28, 2023

Hey :)

Reopening this towards #909 :)

@Tahul Tahul reopened this Jun 28, 2023
@Tahul
Copy link
Contributor

Tahul commented Jun 28, 2023

@atinux @danielroe @pi0 @antfu ; any websites from Nuxt modules you would like to see updated that are not in that issue list?

I'll be sending a batch of PRs upgrading existing websites to pre-releases so we can properly test and document the migration from v1 to v2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants