Skip to content

Commit 6ffdabe

Browse files
akurinnoyclaude
andcommitted
Merge main and nest Claude Code docs under existing AI assistants section
Resolve nav.adoc conflict by nesting Claude Code configuration persistence pages under the existing "Using AI assistants in workspaces" section from main, instead of a separate "AI coding tools in workspaces" section. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Oleksii Kurinnyi <okurinny@redhat.com>
2 parents a37b627 + 093dfdd commit 6ffdabe

123 files changed

Lines changed: 1370 additions & 793 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/preview-sticky-comment.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,8 @@ jobs:
1818
runs-on: ubuntu-latest
1919
steps:
2020
- name: create
21-
uses: actions-cool/maintain-one-comment@v3
21+
uses: marocchino/sticky-pull-request-comment@v2
2222
with:
23-
token: ${{ secrets.GITHUB_TOKEN }}
24-
body: |
23+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
24+
message: |
2525
⚡️ Deploying pull request preview...
26-
<!-- Sticky Pull Request Comment -->
27-
body-include: "<!-- Sticky Pull Request Comment -->"

.github/workflows/publish-netlify.yml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,9 @@ jobs:
4747
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
4848

4949
- name: Update status comment
50-
uses: actions-cool/maintain-one-comment@v3
50+
uses: marocchino/sticky-pull-request-comment@v2
5151
with:
52-
token: ${{ secrets.GITHUB_TOKEN }}
53-
body: |
54-
🎊 Navigate the preview: ${{ steps.netlify-publish.outputs.NETLIFY_URL }} 🎊
55-
<!-- Sticky Pull Request Comment -->
56-
body-include: "<!-- Sticky Pull Request Comment -->"
52+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5753
number: ${{ steps.vars.outputs.pr_number }}
54+
message: |
55+
🎊 Navigate the preview: ${{ steps.netlify-publish.outputs.NETLIFY_URL }} 🎊
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
From 3a08d09838b9f195c37b1621f8e5ca99cda998ad Mon Sep 17 00:00:00 2001
2+
From: Gaurav Trivedi <gtrivedi@redhat.com>
3+
Date: Tue, 16 Jun 2026 19:59:42 +0530
4+
Subject: [PATCH] fix: Make Discover the first top-level section per SME
5+
feedback
6+
MIME-Version: 1.0
7+
Content-Type: text/plain; charset=UTF-8
8+
Content-Transfer-Encoding: 8bit
9+
10+
Addresses SME feedback from ibuziuk on PR #3098:
11+
- Move Discover to first position in navigation
12+
- Include 'Introduction to Che' and 'Eclipse Che hosted by Red Hat' in Discover section
13+
- Remove redundant overview and hosted-che from main nav (content accessible via Discover)
14+
- Logical user flow: Discover → Use → Administer
15+
16+
This creates a better user journey where users first discover what Eclipse Che
17+
is and explore hosted options before diving into detailed architecture.
18+
19+
Co-Authored-By: Claude Sonnet 4 <noreply@anthropic.com>
20+
---
21+
antora.yml | 2 --
22+
modules/discover/nav.adoc | 2 ++
23+
2 files changed, 2 insertions(+), 2 deletions(-)
24+
25+
diff --git a/antora.yml b/antora.yml
26+
index 805ff274..f40b9f10 100644
27+
--- a/antora.yml
28+
+++ b/antora.yml
29+
@@ -5,8 +5,6 @@ version: next
30+
prerelease: true
31+
start_page: overview:introduction-to-eclipse-che.adoc
32+
nav:
33+
- - modules/overview/nav.adoc
34+
- - modules/hosted-che/nav.adoc
35+
- modules/discover/nav.adoc
36+
- modules/end-user-guide/nav.adoc
37+
- modules/administration-guide/nav.adoc
38+
diff --git a/modules/discover/nav.adoc b/modules/discover/nav.adoc
39+
index d21c3f64..f6f27c59 100644
40+
--- a/modules/discover/nav.adoc
41+
+++ b/modules/discover/nav.adoc
42+
@@ -1,5 +1,7 @@
43+
.Discover
44+
45+
+* xref:overview:introduction-to-eclipse-che.adoc[]
46+
+* xref:hosted-che:hosted-che.adoc[]
47+
* xref:architecture-overview.adoc[]
48+
** xref:server-components.adoc[]
49+
*** xref:che-operator.adoc[]
50+
--
51+
2.54.0
52+

antora.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ version: next
55
prerelease: true
66
start_page: overview:introduction-to-eclipse-che.adoc
77
nav:
8-
- modules/overview/nav.adoc
9-
- modules/hosted-che/nav.adoc
8+
- modules/discover/nav.adoc
9+
- modules/install/nav.adoc
1010
- modules/end-user-guide/nav.adoc
1111
- modules/administration-guide/nav.adoc
1212
- modules/extensions/nav.adoc
@@ -98,8 +98,8 @@ asciidoc:
9898
prod-upstream: Eclipse&#160;Che
9999
prod-url: "https://__&lt;che_fqdn&gt;__"
100100
prod-ver-major: "7"
101-
prod-ver-patch: "7.118.0"
102-
prod-ver: "7.118"
101+
prod-ver-patch: "7.119.0"
102+
prod-ver: "7.119"
103103
prod-workspace: che-ws
104104
prod: Eclipse&#160;Che
105105
prod2: Eclipse&#160;Che
@@ -133,6 +133,6 @@ ext:
133133
- run:
134134
command: ./tools/create_architecture_diagrams.py
135135
scan:
136-
base: modules/administration-guide/images/architecture/
136+
base: modules/discover/images/architecture/
137137
dir: build/collector/architecture-diagrams
138138
files: '*.png'

modules/administration-guide/examples/proc_che-configuring-ingresses.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ spec:
2626

2727
.Additional resources
2828

29-
* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
29+
* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
3030

3131
* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]

modules/administration-guide/examples/snip_che-concealing-editors-additional-resources.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
.Additional resources
44

5-
* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
5+
* xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
66
77
* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
88

modules/administration-guide/examples/snip_che-upgrading-the-chectl-management-tool.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This section describes how to upgrade the `{prod-cli}` management tool.
44

55
.Prerequisites
66

7-
* `{prod-cli}`. See: xref:installing-the-chectl-management-tool.adoc[].
7+
* `{prod-cli}`. See: xref:install:installing-the-chectl-management-tool.adoc[].
88
99
.Procedure
1010

modules/administration-guide/nav.adoc

Lines changed: 3 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,9 @@
11
.Administration Guide
22

33
* xref:security-best-practices.adoc[]
4-
* xref:preparing-the-installation.adoc[]
5-
** xref:supported-platforms.adoc[]
6-
** xref:installing-the-chectl-management-tool.adoc[]
7-
** xref:architecture-overview.adoc[]
8-
*** xref:server-components.adoc[]
9-
**** xref:che-operator.adoc[]
10-
**** xref:devworkspace-operator.adoc[]
11-
**** xref:gateway.adoc[]
12-
**** xref:dashboard.adoc[]
13-
**** xref:che-server.adoc[]
14-
**** xref:che-devfile-registry.adoc[]
15-
**** xref:plugin-registry.adoc[]
16-
*** xref:user-workspaces.adoc[]
17-
** xref:calculating-che-resource-requirements.adoc[]
18-
* xref:running-at-scale.adoc[]
19-
// Install
20-
* xref:installing-che.adoc[]
21-
** Deploy on OpenShift
22-
*** xref:proc_installing-che-on-openshift-using-cli.adoc[]
23-
*** xref:proc_installing-che-on-openshift-using-the-web-console.adoc[]
24-
*** xref:proc_installing-che-on-openshift-with-keycloak-as-oidc.adoc[]
25-
** Deploy on {kubernetes}
26-
*** xref:installing-che-on-microsoft-azure.adoc[]
27-
*** xref:installing-che-on-amazon-elastic-kubernetes-service.adoc[]
28-
*** xref:proc_installing-che-on-the-virtual-kubernetes-cluster.adoc[]
29-
** Deploy locally
30-
*** xref:proc_installing-che-on-red-hat-openshift-local.adoc[]
31-
*** xref:proc_installing-che-on-minikube.adoc[]
32-
*** xref:proc_installing-che-on-minikube-keycloak-oidc.adoc[]
33-
** Deploy in a restricted environment
34-
*** xref:proc_installing-che-in-a-restricted-environment.adoc[]
35-
** xref:proc_finding-the-fully-qualified-domain-name-fqdn.adoc[]
36-
** xref:permissions-to-install-che.adoc[]
37-
*** xref:ref_permissions-to-install-che-on-openshift-using-cli.adoc[]
38-
*** xref:ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc[]
394
* xref:configuring-che.adoc[]
405
** xref:understanding-the-checluster-custom-resource.adoc[]
41-
*** xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
6+
*** xref:install:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
427
*** xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
438
*** xref:checluster-custom-resource-fields-reference.adoc[]
449
** xref:configuring-namespace-provisioning.adoc[]
@@ -97,6 +62,8 @@
9762
*** xref:configuring-default-editor.adoc[]
9863
*** xref:concealing-editors.adoc[]
9964
*** xref:configuring-editors-download-urls.adoc[]
65+
*** xref:configuring-ai-providers.adoc[]
66+
**** xref:ai-provider-api-key-secret-reference.adoc[]
10067
*** xref:customizing-openshift-che-branding-images.adoc[]
10168
** xref:managing-identities-and-authorizations.adoc[]
10269
*** xref:configuring-oauth-for-git-providers.adoc[]
@@ -137,4 +104,3 @@
137104
** xref:upgrading-che-using-the-cli-management-tool.adoc[]
138105
** xref:upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc[]
139106
** xref:repairing-the-devworkspace-operator-on-openshift.adoc[]
140-
* xref:proc_uninstalling-che.adoc[]
Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
:_content-type: REFERENCE
2+
:description: Kubernetes Secret schema, labels, and naming convention for AI provider API keys that are automatically mounted into workspace containers.
3+
:keywords: administration, ai, api key, secret, kubernetes, devworkspace controller, environment variable, mount
4+
:navtitle: AI provider API key secret reference
5+
:page-aliases:
6+
7+
[id="ai-provider-api-key-secret-reference"]
8+
= AI provider API key secret reference
9+
10+
[role="_abstract"]
11+
Each user's AI provider API key is stored as a {kubernetes} `Opaque` Secret in the user's personal {orch-namespace}. The {devworkspace} Controller automatically mounts matching Secrets as environment variables into all workspace containers. Use this reference when manually creating or troubleshooting AI provider key Secrets.
12+
13+
== Secret schema
14+
15+
[source,yaml,subs="+quotes,+attributes"]
16+
----
17+
apiVersion: v1
18+
kind: Secret
19+
metadata:
20+
name: ai-provider-openai-api-key <1>
21+
namespace: __<user-namespace>__
22+
labels:
23+
controller.devfile.io/mount-to-devworkspace: 'true' <2>
24+
controller.devfile.io/watch-secret: 'true' <3>
25+
che.eclipse.org/ai-provider-id: opencodeai-opencode <4>
26+
annotations:
27+
controller.devfile.io/mount-as: env <5>
28+
type: Opaque
29+
data:
30+
OPENAI_API_KEY: __<base64-encoded-api-key>__ <6>
31+
----
32+
<1> Secret name is derived as `ai-provider-` + `envVarName.toLowerCase().replace(/_/g, '-')`. For `OPENAI_API_KEY` the name is `ai-provider-openai-api-key`.
33+
<2> Instructs the DevWorkspace Controller to mount this Secret into all `DevWorkspace` containers in the namespace.
34+
<3> Instructs the DevWorkspace Controller to watch for Secret changes and re-mount without a workspace restart.
35+
<4> Sanitized provider ID (characters other than letters, digits, dots, underscores, and dashes are replaced with dashes). Identifies which AI provider this Secret belongs to. Used by the {prod-short} dashboard to detect existing keys.
36+
<5> Mounts the Secret data keys as environment variables (not as files).
37+
<6> The data key is the environment variable name. The value is base64-encoded. The variable is injected directly into all workspace containers.
38+
39+
== Label and annotation reference
40+
41+
[cols="1,1,2",options="header"]
42+
|===
43+
| Label / Annotation | Value | Purpose
44+
45+
| `controller.devfile.io/mount-to-devworkspace`
46+
| `'true'`
47+
| Causes the DevWorkspace Controller to mount this Secret into every `DevWorkspace` in the namespace.
48+
49+
| `controller.devfile.io/watch-secret`
50+
| `'true'`
51+
| The DevWorkspace Controller re-mounts the Secret when its data changes, without requiring a workspace restart.
52+
53+
| `controller.devfile.io/mount-as`
54+
| `env`
55+
| Each data key in the Secret becomes an environment variable with the key as the variable name and the decoded value as the variable value.
56+
57+
| `che.eclipse.org/ai-provider-id`
58+
| Sanitized provider ID (for example, `opencodeai-opencode`). Characters other than letters, digits, dots, underscores, and dashes are replaced with dashes.
59+
| Used by the {prod-short} dashboard to identify and list AI provider key Secrets when rendering the AI Selector widget.
60+
|===
61+
62+
== Secret naming convention
63+
64+
Secret names follow the pattern:
65+
66+
----
67+
ai-provider-<envVarName-lowercased-underscores-as-dashes>
68+
----
69+
70+
Example:
71+
72+
[cols="1,1",options="header"]
73+
|===
74+
| `envVarName` | Secret name
75+
76+
| `OPENAI_API_KEY`
77+
| `ai-provider-openai-api-key`
78+
|===
79+
80+
== Manual Secret creation
81+
82+
Advanced users can create AI provider key Secrets manually using `{orch-cli}` instead of the dashboard UI. Use the same labels and annotations as shown in the schema above:
83+
84+
[subs="+quotes,+attributes"]
85+
----
86+
$ {orch-cli} apply -f - <<EOF
87+
apiVersion: v1
88+
kind: Secret
89+
metadata:
90+
name: ai-provider-openai-api-key
91+
namespace: __<user-namespace>__
92+
labels:
93+
controller.devfile.io/mount-to-devworkspace: 'true'
94+
controller.devfile.io/watch-secret: 'true'
95+
che.eclipse.org/ai-provider-id: opencodeai-opencode
96+
annotations:
97+
controller.devfile.io/mount-as: env
98+
type: Opaque
99+
data:
100+
OPENAI_API_KEY: __<base64-encoded-api-key>__
101+
EOF
102+
----
103+
104+
.Additional resources
105+
106+
* xref:configuring-ai-providers.adoc[]
107+
* xref:end-user-guide:mounting-secrets.adoc[Mounting secrets (end-user guide)]
108+
* link:https://devfile.io/docs/2.2.0/what-is-a-devfile[Devfile documentation]

modules/administration-guide/pages/architecture-overview.adoc

Lines changed: 0 additions & 39 deletions
This file was deleted.

0 commit comments

Comments
 (0)