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

docs: existing links to "VS Code Server" should be updated #750

Open
NdagiStanley opened this issue Nov 11, 2024 · 2 comments
Open

docs: existing links to "VS Code Server" should be updated #750

NdagiStanley opened this issue Nov 11, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@NdagiStanley
Copy link

📚 Is your documentation request related to a problem?

The following are the concerned links:

  • For more information on the benefits and features of VS Code Server, refer to [the official Visual Studio Code blog](https://code.visualstudio.com/blogs/2022/07/07/vscode-server)
  • description: 'It seems you don\'t have code-server installed.\n\nLearn more about it with <a href="https://code.visualstudio.com/blogs/2022/07/07/vscode-server" target="_blank">this guide</a>.\nOnce installed, restart Nuxt and visit this tab again.',

The existing links point to an outdated post on the "Visual Studio Code" blog here. While there's an updated blog post mentioned in said outdated post; find it here, it's likely that more posts have followed or may could follow.

I suggest linking to the "VS Code Server" documentation page here, instead.

🔍 Where should you find it?

Just where it is. I'm not suggesting that the docs' copy or location should change. Only the link should be updated.

Image

Image

ℹ️ Additional context

No response

@NdagiStanley NdagiStanley added the documentation Improvements or additions to documentation label Nov 11, 2024
@antfu
Copy link
Member

antfu commented Nov 14, 2024

I am aware of their newer version of the code server; however, the last time I checked it, because they are moving to the tunnel approach instead of self-host locally, it wouldn't work on Nuxt DevTools because of CORS limits. I am not sure if there would be a solution for that at this moment, so for now, we need to point to the old post for users to follow the legacy approach. If they eventually deprecate that while we can't find a good solution to workaround, we might unfortunately need to remove this feature from Nuxt DevTools.

@NdagiStanley
Copy link
Author

Thank you for the response, @antfu!
That's a great argument.

Please note that, the linked blog post claims that "VS Code Server is in private preview" and points a Nuxt user to sign-up:

Image

yet the form is closed and points to the non-legacy approach: https://aka.ms/vscode-server-doc
Image

Therefore, the Nuxt user is eventually sent to the newer approach. I agree with you that if they eventually deprecate and you can't find a good solution to workaround, then you might need to remove this feature from Nuxt DevTools.

In the meantime, maybe having the legacy approach (captured in the linked blog post) documented in Nuxt documentation may suffice. What do you think? I'm happy to help with that effort.

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

No branches or pull requests

2 participants