Skip to content
This repository has been archived by the owner on Apr 14, 2023. It is now read-only.

Installation instructions are either wrong or misleading #107

Open
davidsneighbour opened this issue Sep 28, 2022 · 8 comments
Open

Installation instructions are either wrong or misleading #107

davidsneighbour opened this issue Sep 28, 2022 · 8 comments
Assignees

Comments

@davidsneighbour
Copy link

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

@ChrisChinchilla
Copy link
Collaborator

@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 ChrisChinchilla self-assigned this Sep 29, 2022
@ChrisChinchilla
Copy link
Collaborator

Fixed by #108

@adamdmharvey
Copy link

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

@jdillard
Copy link

jdillard commented Feb 19, 2023

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.

@jdkato
Copy link
Member

jdkato commented Mar 6, 2023

Here's the problem:

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.

@ChrisChinchilla
Copy link
Collaborator

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…

@adamdmharvey
Copy link

adamdmharvey commented Mar 14, 2023

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

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

@jdillard
Copy link

jdillard commented Mar 14, 2023

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.

@jdkato jdkato mentioned this issue Apr 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants