docs: add AI provider configuration and usage docs by olexii4 · Pull Request #3062 · eclipse-che/che-docs

olexii4 · 2026-04-09T22:05:22Z

What does this pull request change?

Adds documentation for the AI Selector Widget feature introduced in che-dashboard#1505.

Administration Guide

Configuring AI providers (configuring-ai-providers.adoc) — procedure for creating the ai-tool-registry ConfigMap with providers, tools, and default selections.
AI provider API key Secret reference (ai-provider-api-key-secret-reference.adoc) — Secret schema, labels, annotations, naming convention, and manual creation.
CheCluster CR fields reference (checluster-custom-resource-fields-reference.adoc) — AI tool registry ConfigMap reference with provider and tool field tables.

End-User Guide

Using AI assistants in workspaces (using-ai-assistants-in-workspaces.adoc) — overview: default provider, multi-provider selection, AI Provider column in workspaces list, changing AI tool on existing workspaces.
Configuring an AI provider API key (configuring-an-ai-provider-api-key.adoc) — procedure with two paths: Create Workspace page and User Preferences > AI Providers Keys tab.
URL parameter for the AI provider (url-parameter-for-the-ai-provider.adoc) — ai-provider= factory URL parameter with comma-separated provider IDs.

What issues does this pull request fix or reference?

eclipse-che/che#23796

Docs PR for che-dashboard#1505.

Specify the version of the product this pull request applies to

7.117.0

Pull Request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

Any procedure:
- Successfully tested.
Any page or link rename:
- The page contains a redirection for the previous URL.
- Propagate the URL change in:
  - Dashboard default branding data
Builds on Eclipse Che hosted by Red Hat.
the Validate language on files added or modified step reports no vale warnings.

github-actions · 2026-04-09T22:05:31Z

🎊 Navigate the preview: https://6a19810e776e3530c6fd40c7--eclipse-che-docs-pr.netlify.app 🎊

github-actions · 2026-04-09T22:05:32Z

Click here to review and test in web IDE:

ibuziuk

@gtrivedi88 please, review the doc structure, so that it aligns with the new policy
@olexii4 please add the Tech-preview note

gtrivedi88

Added some suggestions. Please let me know if you have questions.

gtrivedi88

JTBD follow-up — missing abstracts and feature-focused framing

Additional issues not covered in the initial review. All 5 new files are missing [role="_abstract"] and several have feature-focused framing in the intro paragraph.

🤖 RHAI docs Claude Code review

svor · 2026-05-28T15:43:29Z

@gtrivedi88 do you have an idea why Preview action doesn't work anymore?

gtrivedi88 · 2026-05-28T16:02:43Z

@svor I think the root cause is the actions-cool/maintain-one-comment repository was blocked by GitHub for a Terms of Service violation on May 19, 2026. That's why every run since May 19 fails and every run before May 18 succeeded.

This is the response from GitHub API:

{"message": "Repository access blocked", "block": {"reason": "tos", "created_at": "2026-05-19T00:34:15Z"}}
The action's repo was taken down by GitHub — not an org policy issue. Nobody in the eclipse-che org changed anything.

Fix: Replace actions-cool/maintain-one-comment@v3 with either:

A different maintained action (e.g., marocchino/sticky-pull-request-comment@v2)
An inline gh CLI script

Creating a PR for fix.

gtrivedi88 · 2026-05-28T16:22:55Z

@svor #3113

gtrivedi88 · 2026-05-28T16:32:02Z

@svor I think we are good now.

svor · 2026-05-29T08:08:52Z

@gtrivedi88 looks like we have similar problem with Publish preview on netlify and the preview is not published

gtrivedi88 · 2026-05-29T10:51:45Z

@svor Can you please review and LGTM: #3115
Once merged, i believe the issue will be fixed here

Assisted-by: Claude Sonnet 4.6 Signed-off-by: Oleksii Orel <oorel@redhat.com>

- Fix section title levels in configuring-an-ai-provider-api-key.adoc (=== to == to follow expected sequence after = heading) - Add end-user-guide: module prefix to cross-module xrefs in ai-provider-api-key-secret-reference.adoc and configuring-ai-providers.adoc - Remove non-existent aiProviders and defaultAiProvider xrefs from checluster-custom-resource-fields-reference.adoc (AI config is ConfigMap-based, not CheCluster CR fields) Assisted-by: Claude Sonnet 4.6 Signed-off-by: Oleksii Orel <oorel@redhat.com>

- Sentence-case all :navtitle: values - Add [role="_abstract"] to all 5 modules with JTBD-focused text - Use imperative verb in procedure titles (Configure, not Configuring) - Use noun phrase for concept title (AI assistants in workspaces) - Fix :description: fields to explain what/why, not restate the title - Add Tech-Preview note to configuring-ai-providers.adoc - Consolidate two consecutive NOTE admonitions into one - Remove custom subheadings from procedure module; present both paths as a single numbered list with choice items - Fix hardcoded Gemini verification commands to generic placeholders - Fix callout 4: correct regex description (all non-identifier chars, not just slashes, are replaced with dashes) - Fix additional resources link: DevWorkspace Operator -> Devfile docs - Extract changing-the-ai-tool procedure into its own module and add xref from the concept page - Add changing-the-ai-tool-on-a-workspace.adoc to end-user nav Assisted-by: Claude Sonnet 4.6 Signed-off-by: Oleksii Orel <oorel@redhat.com>

Replace examples/ path with example$ family prefix required by Antora for including files from the examples/ directory. Assisted-by: Claude Sonnet 4.6 Signed-off-by: Oleksii Orel <oorel@redhat.com>

…mple Replace all GEMINI_API_KEY and ANTHROPIC_API_KEY references with OPENAI_API_KEY. Replace google/gemini and anthropic/claude provider IDs with opencodeai/opencode. Simplify the url-parameter page to a single provider example. Assisted-by: Claude Sonnet 4.6 Signed-off-by: Oleksii Orel <oorel@redhat.com>

- Replace Gemini/Claude dual-provider example with a single OpenCode provider using OPENAI_API_KEY - Add Procedure step with a minimal Dockerfile for building a custom injector image, based on che-incubator/che-ai-tool-images/dockerfiles/ opencode/Dockerfile; explains multi-stage build, wrapper script for OpenShift arbitrary UIDs, and multi-arch build command - Reference che-incubator/che-ai-tool-images for maintained examples - Document all registry.json fields with numbered callouts Assisted-by: Claude Sonnet 4.6 Signed-off-by: Oleksii Orel <oorel@redhat.com>

svor · 2026-05-29T12:20:11Z

@gtrivedi88 thank you, now it's possible to see the preview in PRs

olexii4 requested review from a team, deerskindoll, gtrivedi88 and mkuznyetsov as code owners April 9, 2026 22:05

olexii4 requested a review from amisevsk April 9, 2026 22:05

olexii4 mentioned this pull request Apr 9, 2026

feat: AI Selector Widget eclipse-che/che-dashboard#1505

Open

olexii4 force-pushed the AI_widget branch from 40cb6c0 to 0e049f3 Compare April 10, 2026 04:14

ibuziuk reviewed May 7, 2026

View reviewed changes

olexii4 changed the title ~~[wip]docs: add AI provider configuration and usage docs~~ docs: add AI provider configuration and usage docs May 7, 2026

olexii4 force-pushed the AI_widget branch 2 times, most recently from bd0f738 to 98fb924 Compare May 11, 2026 02:11

gtrivedi88 reviewed May 11, 2026

View reviewed changes

olexii4 force-pushed the AI_widget branch from d6e231f to 83a4f6e Compare May 12, 2026 15:03

olexii4 force-pushed the AI_widget branch from 83a4f6e to 737c426 Compare May 26, 2026 14:06

olexii4 requested a review from svor May 28, 2026 14:11

olexii4 added 6 commits May 29, 2026 14:59

docs: add AI provider configuration and usage docs

d6caab7

Assisted-by: Claude Sonnet 4.6 Signed-off-by: Oleksii Orel <oorel@redhat.com>

fix: use correct Antora family prefix for Tech-Preview snippet include

b220959

Replace examples/ path with example$ family prefix required by Antora for including files from the examples/ directory. Assisted-by: Claude Sonnet 4.6 Signed-off-by: Oleksii Orel <oorel@redhat.com>

chore: retrigger CI after preview action fix (#3113)

83aaaea

svor force-pushed the AI_widget branch from 7830c0a to 83aaaea Compare May 29, 2026 12:00

Conversation

olexii4 commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this pull request change?

Administration Guide

End-User Guide

What issues does this pull request fix or reference?

Specify the version of the product this pull request applies to

Pull Request checklist

Uh oh!

github-actions Bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ibuziuk left a comment

Choose a reason for hiding this comment

Uh oh!

gtrivedi88 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gtrivedi88 left a comment

Choose a reason for hiding this comment

JTBD follow-up — missing abstracts and feature-focused framing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

svor commented May 28, 2026

Uh oh!

gtrivedi88 commented May 28, 2026

Uh oh!

gtrivedi88 commented May 28, 2026

Uh oh!

gtrivedi88 commented May 28, 2026

Uh oh!

svor commented May 29, 2026

Uh oh!

gtrivedi88 commented May 29, 2026

Uh oh!

svor commented May 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

olexii4 commented Apr 9, 2026 •

edited

Loading

github-actions Bot commented Apr 9, 2026 •

edited

Loading

github-actions Bot commented Apr 9, 2026 •

edited

Loading

gtrivedi88 left a comment •

edited

Loading