-
Notifications
You must be signed in to change notification settings - Fork 173
[DOCS-4552] Flat hirerachy to increase readability #3023
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
Open
gtrivedi88
wants to merge
1
commit into
eclipse-che:main
Choose a base branch
from
gtrivedi88:DOCS-4552
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+263
−170
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
2 changes: 1 addition & 1 deletion
2
...s/administration-guide/examples/snip_che-non-default-vsx-registry-instance.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| * The embedded instance of the Open VSX registry that runs in the `plugin-registry` pod of {prod-short} to support air-gapped, offline, and proxy-restricted environments. The embedded Open VSX registry contains only a subset of the extensions published on link:https://open-vsx.org[open-vsx.org]. This subset is xref:adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance[customizable]. | ||
| * The embedded instance of the Open VSX registry that runs in the `plugin-registry` pod of {prod-short} to support air-gapped, offline, and proxy-restricted environments. The embedded Open VSX registry contains only a subset of the extensions published on link:https://open-vsx.org[open-vsx.org]. You can customize this subset xref:adding-or-removing-extensions-in-a-workspace_{context}[using a workspace] or xref:adding-or-removing-extensions-on-linux_{context}[using a Linux operating system]. |
3 changes: 0 additions & 3 deletions
3
...e/examples/snip_che-steps-to-add-or-remove-extensions-in-openvsx-sync-json.adoc
This file was deleted.
Oops, something went wrong.
14 changes: 0 additions & 14 deletions
14
...guide/examples/snip_che-steps-to-build-custom-plugin-registry-in-workspace.adoc
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
105 changes: 105 additions & 0 deletions
105
...istration-guide/partials/proc_adding-or-removing-extensions-in-a-workspace.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| :_content-type: PROCEDURE | ||
|
|
||
| [id="adding-or-removing-extensions-in-a-workspace_{context}"] | ||
| = Adding or removing extensions by using a {prod-short} workspace | ||
|
|
||
| [role="_abstract"] | ||
| You can add or remove extensions in the embedded Open VSX registry instance directly within a {prod-short} workspace to create a custom build for your organization. | ||
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| The embedded plugin registry will be deprecated in future releases and replaced by the Open VSX registry. Setting up an internal, on-premises Open VSX registry provides full control over the extension lifecycle, enables offline use, and improves compliance. Refer to the xref:running-the-open-vsx-on-premises.adoc[Running the Open VSX On-Premises] procedure for detailed setup instructions. | ||
| ==== | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You are logged in to your {prod-short} instance as an administrator. | ||
| * You have started a workspace using the link:https://github.com/eclipse-che/che-plugin-registry[plugin registry repository]. | ||
| * You have created a link:https://access.redhat.com/terms-based-registry/[Red Hat Registry Service Account] and have the username and token available. | ||
| * For IBM Power (`ppc64le`) and IBM Z (`s390x`) architectures, you must build the custom plugin registry locally on the corresponding hardware. | ||
| * (Optional) You can rebuild the container based on the latest tag or SHA to get the latest security fixes after a {prod-short} update. | ||
|
|
||
| .Procedure | ||
|
|
||
| . Open a terminal in your workspace. | ||
|
|
||
| . Check out the Git tag that corresponds to your {prod-short} version: | ||
| + | ||
| [source,bash,subs="+quotes"] | ||
| ---- | ||
| $ git checkout __<product_version>__ | ||
| ---- | ||
|
|
||
| . Identify the publisher and extension name for each extension you want to add: | ||
| .. Find the extension on the link:https://open-vsx.org/[Open VSX registry website]. | ||
| .. Copy the URL of the extension's listing page. | ||
| .. Extract the `<publisher>` and `<name>` from the URL: | ||
| + | ||
| [subs="+quotes"] | ||
| ---- | ||
| https://open-vsx.org/extension/__<publisher>__/__<name>__ | ||
| ---- | ||
| + | ||
| [TIP] | ||
| ==== | ||
| If the extension is only available from link:https://marketplace.visualstudio.com/VSCode[Microsoft Visual Studio Marketplace], but not link:https://open-vsx.org[Open VSX], you can ask the extension publisher to publish it on link:https://open-vsx.org[open-vsx.org] according to these link:https://github.com/eclipse/openvsx/wiki/Publishing-Extensions#how-to-publish-an-extension[instructions], potentially using this link:https://github.com/marketplace/actions/publish-vs-code-extension[GitHub action]. | ||
|
|
||
| If the extension publisher is unavailable or unwilling to publish the extension to link:https://open-vsx.org[open-vsx.org], and if there is no Open VSX equivalent of the extension, consider link:https://github.com/open-vsx/publish-extensions/issues[reporting an issue] to the Open VSX team. | ||
| ==== | ||
|
|
||
| . Open the `openvsx-sync.json` file in the repository. | ||
|
|
||
| . Add or remove extensions using the following JSON syntax: | ||
| + | ||
| [source,json,subs="+quotes"] | ||
| ---- | ||
| { | ||
| "id": "__<publisher>__.__<name>__", | ||
| "version": "__<extension_version>__" | ||
| } | ||
| ---- | ||
| + | ||
| [TIP] | ||
| ==== | ||
| If you have a closed-source extension or an extension developed only for internal use in your organization, you can add the extension directly from a `.vsix` file by using a URL accessible to your custom plugin registry container: | ||
|
|
||
| [source,json,subs="+quotes"] | ||
| ---- | ||
| { | ||
| "id": "__<publisher>__.__<name>__", | ||
| "download": "__<url_to_download_vsix_file>__", | ||
| "version": "__<extension_version>__" | ||
| } | ||
| ---- | ||
|
|
||
| Read the link:https://aka.ms/vsmarketplace-ToU[Terms of Use] for the link:https://marketplace.visualstudio.com/VSCode[Microsoft Visual Studio Marketplace] before using its resources. | ||
| ==== | ||
|
|
||
| . Log in to the Red Hat registry: | ||
| .. Navigate to *Terminal* -> *Run Task...* -> *devfile*. | ||
| .. Run the *1. Login to registry.redhat.io* task. | ||
| .. Enter your Red Hat Registry Service Account credentials when prompted. | ||
|
|
||
| . Build and publish the custom plugin registry: | ||
| .. Navigate to *Terminal* -> *Run Task...* -> *devfile*. | ||
| .. Run the *2. Build and Publish a Custom Plugin Registry* task. | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| Verify that the `CHE_CODE_VERSION` in the `build-config.json` file matches the version of the editor currently used with {prod-short}. Update it if necessary. | ||
| ==== | ||
|
|
||
| . Configure {prod-short} to use the custom plugin registry: | ||
| .. Navigate to *Terminal* -> *Run Task...* -> *devfile*. | ||
| .. Run the *3. Configure Che to use the Custom Plugin Registry* task. | ||
|
|
||
| .Verification | ||
|
|
||
| . Check that the `plugin-registry` pod has restarted and is running. | ||
| . Restart your workspace. | ||
| . Open the *Extensions* view in the IDE and verify that your added extensions are available. | ||
|
|
||
| .Additional resources | ||
|
|
||
| * link:https://github.com/eclipse-che/che-plugin-registry[Plugin registry repository] | ||
| * xref:running-the-open-vsx-on-premises.adoc[Running the Open VSX On-Premises] | ||
135 changes: 0 additions & 135 deletions
135
...c_adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance.adoc
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's already deprecated. See this PR: #3019