search

mtxr / vscode-sqltools

Database management for VSCode
https://vscode-sqltools.mteixeira.dev?utm_source=github&utm_medium=homepage-link
MIT License
1.43k stars 291 forks source link

Add "Getting Started" to home #1232

Closed richb-hanover closed 8 months ago

richb-hanover commented 8 months ago

As a relative newcomer to VScode, I had a hard time understanding how SQLTools "worked" in the VScode ecosystem.

I felt your documentation was missing a description of how to get started. (I have to compliment you - the actual installation process is flawless, once I learned where to look.)

Here's an introductory paragraph that would have been a useful hint for me. Thanks!

Describe here what is this PR about and what we are achieving merging this.

Thank you for your contribution! Before submitting this PR, please make sure:

archiewood commented 8 months ago

(Agree - this also confused me initially)

gjsjohnmurray commented 8 months ago

Thanks for your PR. Here are some suggestions:

  1. Use the term "VS Code" instead of "VScode".
  2. Instead of pointing the user to Marketplace, tell them to go to VS Code's Extensions view (a textual way is to run View: Show Extensions from Command Palette), then enter the search text @tag:sqltools-driver, then install the driver they need. A dependency will cause the core SQLTools extension to get installed too.
  3. We don't want the official documentation to link to 3rd-party YouTube videos.
richb-hanover commented 8 months ago
  1. Use the term "VS Code" instead of "VScode".

Yes. I was confused about this, but in the Visual Studio site, Microsoft says, "By using VS Code, you agree to its license and privacy statement..." I'll update

  1. Instead of pointing the user to Marketplace, tell them to go to VS Code's Extensions view (a textual way is to run View: Show Extensions from Command Palette), then enter the search text @tag:sqltools-driver, then install the driver they need. A dependency will cause the core SQLTools extension to get installed too.

I updated this as well. I'll note that this procedure hides all the good work that you've done to make the installation process flawless. (My earlier instructions just say "Go to Marketplace; Install SQLTools; Install your driver; Create the connection" and you're on the air.)

  1. We don't want the official documentation to link to 3rd-party YouTube videos.

I get it. You should consider making your own video - it really helps newcomers get started.

Thanks!

richb-hanover commented 8 months ago

I'm feeling dopey here... It looks as if you have merged the "Getting Started" section into mtxr:dev, but I don't see it on the main README file. What am I missing?

Oh, wait! I just figured it out. The main README and home.mdx in the /docs/... directory need to be kept in sync...

What's the best way to patch this up? Many thanks!

richb-hanover commented 8 months ago

And the answer (to "What's the best way to patch this up?") is #1240 Thanks again.