Commit f9ee350
docs: restructure Open VSX on-premises documentation (#3078)
* docs: add procedure to deploy Open VSX with a pre-built image
Replaces the workspace-based deployment section of the monolithic
running-the-open-vsx-on-premises.adoc page. Shows actual commands
instead of opaque devfile task references. Fixes CRW-10789 by
removing the notified column from the personal_access_token INSERT.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* docs: add procedure to deploy Open VSX from source
Replaces the CLI-based deployment section and build steps from the
monolithic running-the-open-vsx-on-premises.adoc page. Fixes CRW-10789
SQL bug, updates stale eclipse/openvsx URLs, fixes AsciiDoc source
block syntax.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
* docs: add procedure to configure internal Open VSX access
Extracts the 'Setting Up Internal Access' section from the monolithic
running-the-open-vsx-on-premises.adoc into a standalone, JTBD-aligned
procedure for security hardening.
* docs: rewrite Open VSX registry URL configuration procedure
Adds proper abstract, prerequisites, definition lists, verification,
rate limiting note, air-gap warning, and Additional resources.
Adapted from downstream CQA 2.1-compliant content.
* docs: promote delete-via-API procedure to standalone page
Moves from partials/ to pages/ for independent discoverability.
Fixes CRW-10789 SQL bug (removes notified column), replaces
hardcoded oc with {orch-cli}, converts to definition lists.
* docs: promote delete-from-DB procedure to standalone page
Moves from partials/ to pages/ for independent discoverability.
Replaces hardcoded oc with {orch-cli}, adds Antora metadata,
adds Additional resources with xref to admin API method.
* docs: rewrite IDE extensions concept page with JTBD framing
Replaces thin wrapper (one sentence + xref list) with proper concept
explaining WHY extension management matters and the three registry
options. All links in Additional resources per DITA ConceptLink rule.
* docs: update nav.adoc for restructured Open VSX section
Replaces 3 monolithic entries with 7 focused pages following
JTBD user journey: understand → configure → deploy → secure → maintain.
* docs: remove replaced monolithic pages, snippets, and partials
Removes files superseded by the new modular structure:
- running-the-open-vsx-on-premises.adoc (replaced by 3 focused procedures)
- deleting-extension-from-the-open-vsx-on-premises.adoc (thin wrapper)
- snip_che-deploy-open-vsx.adoc (content inlined)
- snip_che-deploy-open-vsx-using-oc.adoc (content inlined)
- partials/proc_deleting-* (promoted to standalone pages)
Updates xrefs in out-of-scope partials that referenced the deleted page.
* docs: fix broken xrefs to partial files in registry URL procedure
Replace xrefs to non-page partials (adding-or-removing-extensions-*)
with xref to their parent page (extensions-for-microsoft-visual-studio-
code-open-source.adoc) for valid Antora resolution.
* docs: add Next steps, fix SQL, add workspace deploy procedure
Address SME review feedback:
- Restore notified column in SQL INSERT statements (mandatory for
OpenVSX v0.33.0+) in all 3 procedure files
- Add image compatibility note to pre-built deploy procedure
- Add new procedure: deploy Open VSX from a Che workspace using
devfile tasks (preserves devfile-based workflow for existing users)
- Update nav.adoc and concept page with workspace procedure xref
- Add Next steps to deploy procedures
- Fix broken xrefs to partial files in registry URL procedure
- Fix Vale errors (namespace wording)
* docs: remove pre-built image procedure (upstream-only deploy is from source)
The openvsx-deployment-no-es.yml template requires custom-built images,
which only exist downstream. Remove the misleading pre-built image
procedure from upstream and redirect all xrefs to the from-source
procedure.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>1 parent 6f8511c commit f9ee350
15 files changed
Lines changed: 584 additions & 475 deletions
File tree
- modules/administration-guide
- examples
- pages
- partials
Lines changed: 0 additions & 153 deletions
This file was deleted.
Lines changed: 0 additions & 30 deletions
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
113 | 113 | | |
114 | 114 | | |
115 | 115 | | |
116 | | - | |
117 | | - | |
118 | 116 | | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
119 | 122 | | |
120 | 123 | | |
121 | 124 | | |
| |||
Lines changed: 52 additions & 13 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
4 | | - | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
9 | 9 | | |
10 | | - | |
11 | | - | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
12 | 25 | | |
13 | 26 | | |
14 | | - | |
| 27 | + | |
| 28 | + | |
15 | 29 | | |
16 | | - | |
| 30 | + | |
17 | 31 | | |
18 | 32 | | |
19 | | - | |
20 | | - | |
21 | | - | |
22 | | - | |
23 | | - | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
24 | 36 | | |
25 | 37 | | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
26 | 58 | | |
27 | 59 | | |
28 | 60 | | |
29 | 61 | | |
30 | 62 | | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
31 | 69 | | |
| 70 | + | |
32 | 71 | | |
33 | 72 | | |
Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 23 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
| 2 | + | |
| 3 | + | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
11 | 25 | | |
12 | 26 | | |
13 | | - | |
14 | | - | |
15 | 27 | | |
16 | | - | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
Lines changed: 49 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
0 commit comments