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

Change logo and name #458

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

tmattio
Copy link
Collaborator

@tmattio tmattio commented Nov 30, 2020

This PR addresses part of the concerns raised in #457:

  • Change the logo to the official OCaml logo
  • Change the name of the extension to OCaml

For the second point, the name currently collides with @hackwaly's extension, but he agreed to deprecate it in favor of this one, so if hackwaly/vscode-ocaml#124 is merged with the name update, that won't be a problem anymore.

Merge blocked by the PR above, and a new release of hackwaly/vscode-ocaml.

@mnxn
Copy link
Collaborator

mnxn commented Nov 30, 2020

Is changing the extension ID from ocamllabs.ocaml-platform something that we want to do right now? I think it would be listed as a different extension on the marketplace and make it harder for existing users to update.

If this repo ever moves to the https://github.com/ocaml organization, maybe we could change the ID to ocaml.ocaml then?

@tmattio
Copy link
Collaborator Author

tmattio commented Nov 30, 2020

I think it would be listed as a different extension on the marketplace

I don't think that's the case. The PR I mentioned renamed the extension ID from ocaml to ocaml-deprecated and the old extension is not listed in the market place anymore: https://marketplace.visualstudio.com/search?term=ocaml&target=VSCode&category=All%20categories&sortBy=Relevance

@mnxn
Copy link
Collaborator

mnxn commented Nov 30, 2020

That extension is still listed under hackwaly.ocaml:
https://marketplace.visualstudio.com/items?itemName=hackwaly.ocaml

hackwaly.ocaml-deprecated is a 404:
https://marketplace.visualstudio.com/items?itemName=hackwaly.ocaml-deprecated

I don't see how it would be possible for the vsce tool to detect an extension ID change since it reads from the package.json to decide what extension it's publishing in the first place.

If we're planning to move to the ocaml organization/publisher (are we?), I'd prefer to wait until then to change the extension ID in order to minimize changes. Just changing the extension title and icon should be sufficient to improve discoverability.

@tmattio
Copy link
Collaborator Author

tmattio commented Nov 30, 2020

That extension is still listed under hackwaly.ocaml:

That's very strange: https://github.com/hackwaly/vscode-ocaml/pull/124/files#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519R3

I don't see how it would be possible for the vsce tool to detect an extension ID

Maybe it cross-checks with the VCS URI?

I'd prefer to wait until then to change the extension ID in order to minimize changes

Sure that sounds reasonable

@hackwaly
Copy link
Collaborator

hackwaly commented Dec 1, 2020

That extension is still listed under hackwaly.ocaml:
https://marketplace.visualstudio.com/items?itemName=hackwaly.ocaml

hackwaly.ocaml-deprecated is a 404:
https://marketplace.visualstudio.com/items?itemName=hackwaly.ocaml-deprecated

I don't see how it would be possible for the vsce tool to detect an extension ID change since it reads from the package.json to decide what extension it's publishing in the first place.

If we're planning to move to the ocaml organization/publisher (are we?), I'd prefer to wait until then to change the extension ID in order to minimize changes. Just changing the extension title and icon should be sufficient to improve discoverability.

I worry about directly change ocaml to ocaml-deprecated in package.json just results two published extensions - one is ocaml the other is ocaml-deprecated. So I didn't use ocaml-deprecated to publish.

AFAIK. There's no name conflict policy in vscode marketplace. So you can use ocamllabs/ocaml without issue.

EDIT: There may be some vsce command to rename extension. Not just change the package.json. But I have no time to find out that.

@mnxn
Copy link
Collaborator

mnxn commented Dec 1, 2020

I worry about directly change ocaml to ocaml-deprecated in package.json just results two published extensions - one is ocaml the other is ocaml-deprecated. So I didn't use ocaml-deprecated to publish.

That is my guess too. That is also why I don't want to rename ocamllabs.ocaml-platform to ocamllabs.ocaml right now, because it might confuse users.

AFAIK. There's no name conflict policy in vscode marketplace. So you can use ocamllabs/ocaml without issue.

Yeah, I don't think there's any name conflict right now. My worry is about the user experience of switching the ID: if it causes two published extension or stops the extension from updating.

@tmattio
Copy link
Collaborator Author

tmattio commented Jan 20, 2021

I don't think we should wait for the move of the repository to merge this anymore, so I reverted the name change, and this PR now only updates the displayed name and the logo.

Ready to merge when approved.

@mnxn
Copy link
Collaborator

mnxn commented Jan 20, 2021

The extension is still being featured on the extensions page: https://marketplace.visualstudio.com/vscode
Should we wait to change the display name/logo until it stops being featured?

@smorimoto: any thoughts?

@smorimoto
Copy link
Collaborator

There should be no problem to change the logo, but I don't know the name. If it can be handled as another extension, you should be very careful about that. If something goes wrong, there's nothing to gain and everything to lose.

@smorimoto
Copy link
Collaborator

smorimoto commented Jan 22, 2021

Honestly, I don't really think icon and name are blocking adoption right now. In the case of F#, Ionide is the most popular one, but I have never decided not to use it by name, and no one around me has made such a decision. Maybe the best way is to promote it enough in a diffusive medium like OCaml's Twitter account. I doubt the logo and name are really a problem.

@tmattio
Copy link
Collaborator Author

tmattio commented Feb 8, 2021

Closing for now, as it seems a bit stale. I guess we can revisit when (if) we move the repo to the OCaml org.

@tmattio tmattio closed this Feb 8, 2021
@tmattio tmattio reopened this Sep 14, 2022
@tmattio
Copy link
Collaborator Author

tmattio commented Sep 14, 2022

Re-opening the PR - let's coordinate the rebranding and move to the OCaml organisation.

What's blocking the transfer of the repository to ocaml/vscode-ocaml is an announcement on Discuss.
I'm writing it, but it'd be great if I could get approval on principle for this PR, then I could:

  • Post the announcement
  • Move the repository
  • Cut a release

Moving the extension to an official publish for OCaml can be done separately and will need assistance from the VSCode support, so let's do this as a second step.

@@ -56,8 +56,8 @@ module Commands = struct

let open_ocamllsp_output = ocaml_prefixed "open-ocamllsp-output"

let open_ocaml_platform_ext_output =
ocaml_prefixed "open-ocaml-platform-ext-output"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't this a breaking change?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess if users have associated a keybinding to it, it is yes. It's a pretty niche use case I feel, but if you feel we shouldn't change the ID I'll revert this

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

Successfully merging this pull request may close these issues.

None yet

5 participants