vale-vscode icon indicating copy to clipboard operation
vale-vscode copied to clipboard

Installation instructions are either wrong or misleading

Open davidsneighbour opened this issue 3 years ago • 8 comments

The install instructions in point 2 of README.md state:

install vale-vscode (this extension) via the Marketplace;

Someone who is used to install extensions might ignore the "via the Marketplace" part and try to find vale-vscode in the extensions tab. That extension does not exist. Turns out its name is Vale in the tab. Searching for errata-ai.vale-server will find the extension.

I propose to change that instruction into something like:


  1. Install extensions by either searching for errata-ai.vale-server in your extensions or following the instructions on the Marketplace

davidsneighbour avatar Sep 28 '22 12:09 davidsneighbour

@davidsneighbour I think this is just a remnant from my failed attempt to rename some things, will handle as part of a forthcoming release.

ChrisChinchilla avatar Sep 29 '22 05:09 ChrisChinchilla

Fixed by #108

ChrisChinchilla avatar Oct 01 '22 13:10 ChrisChinchilla

Believe this was indeed fixed by PR #108; recommend this could be closed? Current instructions work fine for me.

adamdmharvey avatar Dec 22 '22 13:12 adamdmharvey

I would argue the original issue hasn't been fixed, as the following things are still confusing:

  1. It calls the extension vale-server, but from a normal user's point of view, VSCode refers to the extension as just Vale. I realize that under the hood, the extension is called errata-ai.vale-server, as in ext install errata-ai.vale-server, but I'm not sure documenting the "under the hood" name is best in the README.

    Install vale-server (this extension) via the Marketplace;

  2. This, while previously stating that support for Vale Server has been dropped in the "vale-server" extension, (the link to Vale Server is a 404 now btw), which would make the user potentially wonder if the extension itself has been deprecated.

    As of v0.15.0, the extension drops support for Vale Server which has ceased development.

jdillard avatar Feb 19 '23 20:02 jdillard

Here's the problem:

  • This extension started out as being Vale Server-only (hence the name).
  • Later on, support for the CLI was added but we (@ChrisChinchilla and I) decided against renaming it for marketplace reasons (#4).
  • The original Vale Server functionality has now been deprecated.

I realize that this is confusing, but the concerns expressed in #4 still stand. The only way we can rename the extension (in terms of the id, not merely the display name) to better reflect its current state is to publish a new extension and direct users there.

I think doing so now makes more sense than it did originally, though, because the id no longer reflects the true functionality of the extension.

jdkato avatar Mar 06 '23 07:03 jdkato

It might be worth checking to see if anything has changed in the store end to make this easier. I can imagine we are not the only peopler with this issue…

ChrisChinchilla avatar Mar 14 '23 10:03 ChrisChinchilla

Few folks have indicated that by contacting the Marketplace admins you can transfer an extension to another publisher ( ~~or rename the ID~~ ):

  • https://github.com/microsoft/vscode/issues/92996
  • https://developercommunity.visualstudio.com/t/marketplace-allow-rename-of-publisher-name-id/617189

Looks like the admins stopped allowing renames due to complications. 😁

adamdmharvey avatar Mar 14 '23 12:03 adamdmharvey

My point was to not refer to the marketplace ID in the second install step of the README file (I'm pretty sure as a user I don't ever need to know what the ID is), not rename the marketplace ID. Also to remove the 404 link as it isn't adding anything at this point.

jdillard avatar Mar 14 '23 16:03 jdillard