Open VSX switch, Part II (#4319)
* docs: update FAQ with extension gallery info (#2672) * Update app to reflect Open VSX switch. - Remove extension related github configs. - Update tests to reflect new upstream behavior. Co-authored-by: Akash Satheesan <akash@coder.com>
This commit is contained in:
parent
1b60ef418c
commit
e4a797dc9e
|
@ -1,18 +0,0 @@
|
||||||
---
|
|
||||||
name: Extension request
|
|
||||||
about: Request an extension missing from the code-server marketplace
|
|
||||||
title: ""
|
|
||||||
labels: extension-request
|
|
||||||
assignees: ""
|
|
||||||
---
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Details on the code-server extension marketplace are at
|
|
||||||
|
|
||||||
https://github.com/cdr/code-server/blob/master/docs/FAQ.md#whats-the-deal-with-extensions
|
|
||||||
|
|
||||||
Please fill in the issue template!
|
|
||||||
-->
|
|
||||||
|
|
||||||
- [ ] Extension name:
|
|
||||||
- [ ] Extension GitHub or homepage:
|
|
|
@ -19,18 +19,6 @@ labels:
|
||||||
action: comment
|
action: comment
|
||||||
delay: 5s
|
delay: 5s
|
||||||
message: "Thanks for making your first contribution! :slightly_smiling_face:"
|
message: "Thanks for making your first contribution! :slightly_smiling_face:"
|
||||||
extension-request:
|
|
||||||
action: close
|
|
||||||
delay: 5s
|
|
||||||
comment: >
|
|
||||||
Thanks for opening an extension request!
|
|
||||||
We are currently in the process of switching extension
|
|
||||||
marketplaces and transitioning over to [Open VSX](https://open-vsx.org/).
|
|
||||||
Once https://github.com/eclipse/openvsx/issues/249 is implemented, we
|
|
||||||
can fully make this transition. Therefore, we are no longer accepting
|
|
||||||
new requests for extension requests. We suggest installing the VSIX
|
|
||||||
file and then installing into code-server as a temporary workaround.
|
|
||||||
See [docs](https://github.com/cdr/code-server/blob/main/docs/FAQ.md#installing-vsix-extensions-via-the-command-line) for more info.
|
|
||||||
"upstream:vscode":
|
"upstream:vscode":
|
||||||
action: close
|
action: close
|
||||||
delay: 5s
|
delay: 5s
|
||||||
|
|
29
docs/FAQ.md
29
docs/FAQ.md
|
@ -101,8 +101,11 @@ Service](https://cdn.vsassets.io/v/M146_20190123.39/_content/Microsoft-Visual-St
|
||||||
> Visual Studio Products and Services.
|
> Visual Studio Products and Services.
|
||||||
|
|
||||||
Because of this, we can't offer any extensions on Microsoft's marketplace.
|
Because of this, we can't offer any extensions on Microsoft's marketplace.
|
||||||
Instead, we've created a marketplace offering open-source extensions. The
|
Instead, we use the [Open-VSX extension gallery](https://open-vsx.org), which is also used by various other forks.
|
||||||
marketplace works by scraping GitHub for VS Code extensions and building them.
|
It isn't perfect, but its getting better by the day with more and more extensions.
|
||||||
|
|
||||||
|
We also offer our own marketplace for open source extensions, but plan to
|
||||||
|
deprecate it at a future date and completely migrate to Open-VSX.
|
||||||
|
|
||||||
These are the closed-source extensions that are presently unavailable:
|
These are the closed-source extensions that are presently unavailable:
|
||||||
|
|
||||||
|
@ -118,15 +121,8 @@ For more about the closed source portions of VS Code, see [vscodium/vscodium](ht
|
||||||
|
|
||||||
## How can I request an extension that's missing from the marketplace?
|
## How can I request an extension that's missing from the marketplace?
|
||||||
|
|
||||||
We are in the process of transitioning to [Open VSX](https://open-vsx.org/).
|
To add an extension to Open-VSX, please see [open-vsx/publish-extensions](https://github.com/open-vsx/publish-extensions).
|
||||||
Once we've [implemented Open
|
We no longer plan to add new extensions to our legacy extension gallery.
|
||||||
VSX](https://github.com/eclipse/openvsx/issues/249), we can finalize this
|
|
||||||
transition. As such, we are not currently accepting new extension requests.
|
|
||||||
|
|
||||||
In the meantime, we suggest:
|
|
||||||
|
|
||||||
- [Switching to Open VSX](#how-do-i-configure-the-marketplace-url) now
|
|
||||||
- Downloading and [installing the extension manually](#installing-an-extension-manually)
|
|
||||||
|
|
||||||
## How do I install an extension?
|
## How do I install an extension?
|
||||||
|
|
||||||
|
@ -159,20 +155,19 @@ You can also download extensions using the command line. For instance,
|
||||||
downloading from OpenVSX can be done like this:
|
downloading from OpenVSX can be done like this:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
SERVICE_URL=https://open-vsx.org/vscode/gallery ITEM_URL=https://open-vsx.org/vscode/item code-server --install-extension <extension id>
|
code-server --install-extension <extension id>
|
||||||
```
|
```
|
||||||
|
|
||||||
## How do I use my own extensions marketplace?
|
## How do I use my own extensions marketplace?
|
||||||
|
|
||||||
If you own a marketplace that implements the VS Code Extension Gallery API, you
|
If you own a marketplace that implements the VS Code Extension Gallery API, you
|
||||||
can point code-server to it by setting `$SERVICE_URL` and `$ITEM_URL`. These correspond directly
|
can point code-server to it by setting `$EXTENSIONS_GALLERY`.
|
||||||
to `serviceUrl` and `itemUrl` in VS Code's `product.json`.
|
This corresponds directly with the `extensionsGallery` entry in in VS Code's `product.json`.
|
||||||
|
|
||||||
For example, to use [open-vsx.org](https://open-vsx.org), run:
|
For example, to use the legacy Coder extensions marketplace:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
export SERVICE_URL=https://open-vsx.org/vscode/gallery
|
export EXTENSIONS_GALLERY='{"serviceUrl": "https://extensions.coder.com/api"}'
|
||||||
export ITEM_URL=https://open-vsx.org/vscode/item
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Though you can technically use Microsoft's marketplace in this manner, we
|
Though you can technically use Microsoft's marketplace in this manner, we
|
||||||
|
|
Loading…
Reference in New Issue