Skip to content

Commit df8201f

Browse files
[cueweb/docs] Rename CueWeb to OpenCueWeb across documentation (#2484)
## Related Issues - #1800 ## Summarize your change. - Update product name in docs, headings, frontmatter titles, UI labels, table cells, image alt text, and link display text across 26 docs files - Rename rendered diagram labels (mermaid sequence diagram, ASCII architecture box) and .env/bash code-block comments for consistency - Preserve verbatim PR/commit titles in release notes, the CueWebIcon component identifier, and the literal kill-reason string - Leave lowercase cueweb slugs, URLs, permalinks, image paths, CUEWEB_* env vars, and file names unchanged to avoid breaking links <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated product branding throughout from “CueWeb” to **OpenCueWeb** (titles, labels, navigation, and links). * Refreshed getting started, deployment, quick-starts, user/developer guides, tutorials, and references with updated screenshots, diagrams, and UI text. * Clarified **authentication/authorization** behavior, **OpenCueWeb Audit** trail details, **multi-facility** routing, REST Gateway/JWT naming, and operational guidance (including job submission and real-time updates). <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 383de7d commit df8201f

25 files changed

Lines changed: 616 additions & 617 deletions

docs/_docs/concepts/cueweb-rest-gateway.md

Lines changed: 53 additions & 53 deletions
Large diffs are not rendered by default.

docs/_docs/concepts/glossary.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ A graphical user interface for configuring and launching rendering jobs.
6464
Typically runs as a plug-in within 3D software like Maya, Blender, or Nuke,
6565
allowing artists to submit jobs directly from their creative applications.
6666

67-
## CueWeb
67+
## OpenCueWeb
6868

6969
A web-based interface that brings CueGUI's core functionality to the browser.
7070
Offers job management, frame monitoring, real-time updates, and collaborative
@@ -118,7 +118,7 @@ be processed on remote *cores*.
118118

119119
The time elapsed since a running *frame* last wrote to its log. A large LLU on a
120120
frame that is still running is the main signal that the frame may be *stuck* -
121-
the process is alive but no longer making progress. CueWeb's Stuck Frames page
121+
the process is alive but no longer making progress. OpenCueWeb's Stuck Frames page
122122
shows LLU per frame and uses it (relative to runtime) to flag stuck frames.
123123

124124
## Layers
@@ -180,7 +180,7 @@ An administrative action that reassigns the *cores* of busy *procs* to a target
180180
*job* that needs them. The *frames* currently running on those procs are killed
181181
so the freed cores can be booked onto the target job - a way to give a
182182
high-priority job capacity quickly. CueGUI's CueCommander Redirect plugin and
183-
CueWeb's Redirect page expose it.
183+
OpenCueWeb's Redirect page expose it.
184184

185185
## RQD (Python)
186186

@@ -224,7 +224,7 @@ A running *frame* that appears hung: it keeps running but has stopped writing to
224224
its log, so its *Last Log Update (LLU)* keeps climbing relative to its runtime.
225225
A stuck frame is not a distinct frame state - it is detected heuristically (LLU
226226
vs. runtime vs. the *layer*'s average frame time). CueGUI's CueCommander Stuck
227-
Frame plugin and CueWeb's Stuck Frames page list them so you can retry, eat,
227+
Frame plugin and OpenCueWeb's Stuck Frames page list them so you can retry, eat,
228228
kill, or *core up* (raise the minimum cores of) the affected layer.
229229

230230
## Subscription

docs/_docs/concepts/opencue-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ OpenCue components:
5959

6060
* **CueGUI** - The desktop graphical user interface divided into two main workspaces: Cuetopia (artist-focused job monitoring) and CueCommander (administrator-focused system management). Provides comprehensive tools for job monitoring, frame inspection, host management, and system administration.
6161

62-
* **CueWeb** - A web-based interface that brings CueGUI's core functionality to the browser. Offers job management, frame monitoring, real-time updates, and collaborative features accessible from anywhere on the network without requiring client installation.
62+
* **OpenCueWeb** - A web-based interface that brings CueGUI's core functionality to the browser. Offers job management, frame monitoring, real-time updates, and collaborative features accessible from anywhere on the network without requiring client installation.
6363

6464
* **CueSubmit** - A graphical user interface for configuring and launching rendering jobs. Typically runs as a plug-in within 3D software like Maya, Blender, or Nuke, allowing artists to submit jobs directly from their creative applications.
6565

docs/_docs/concepts/versioning.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,18 +39,18 @@ commit and re-submit it with an incremented minor version if needed.
3939

4040
---
4141

42-
## How CueWeb sources its version
42+
## How OpenCueWeb sources its version
4343

44-
CueWeb participates in this shared versioning scheme rather than carrying a version of its own. The version it displays (in the bottom status bar and the **Help &rarr; About CueWeb** dialog) is resolved **once at build time** and exposed to the client as `NEXT_PUBLIC_APP_VERSION`, using the first hit of this chain:
44+
OpenCueWeb participates in this shared versioning scheme rather than carrying a version of its own. The version it displays (in the bottom status bar and the **Help &rarr; About OpenCueWeb** dialog) is resolved **once at build time** and exposed to the client as `NEXT_PUBLIC_APP_VERSION`, using the first hit of this chain:
4545

4646
1. **`NEXT_PUBLIC_APP_VERSION`** (env var / Docker build-arg) - always wins. CI injects the generated OpenCue version or a Git SHA here.
4747
2. **`cueweb/OVERRIDE_CUEWEB_VERSION.in`** - a small override file:
48-
- the default value, the sentinel `VERSION.in`, means "use the repo-root `VERSION.in`" - the same shared source of truth Cuebot and CueGUI read, so CueWeb's number tracks the rest of OpenCue automatically;
49-
- any other value is used **verbatim**, letting a site pin a CueWeb-specific version when it needs to.
48+
- the default value, the sentinel `VERSION.in`, means "use the repo-root `VERSION.in`" - the same shared source of truth Cuebot and CueGUI read, so OpenCueWeb's number tracks the rest of OpenCue automatically;
49+
- any other value is used **verbatim**, letting a site pin an OpenCueWeb-specific version when it needs to.
5050
3. **`package.json`** `version` - a last-resort fallback.
5151

5252
Separately, a **build SHA** is shown for provenance: it comes from the `NEXT_PUBLIC_GIT_SHA` build-arg (CI passes `git rev-parse --short HEAD`) and renders as `unknown` when not supplied.
5353

54-
**Why this design:** defaulting to the repo-root `VERSION.in` keeps CueWeb consistent with OpenCue's policy above (no separate number to bump), while the override file and build-arg give deployments an explicit escape hatch when they need to label a build differently - without code changes.
54+
**Why this design:** defaulting to the repo-root `VERSION.in` keeps OpenCueWeb consistent with OpenCue's policy above (no separate number to bump), while the override file and build-arg give deployments an explicit escape hatch when they need to label a build differently - without code changes.
5555

56-
> In the Docker image the repo-root `VERSION.in` lives outside CueWeb's build context, so it is supplied through a `project_root` build context (see the CueWeb deployment guide).
56+
> In the Docker image the repo-root `VERSION.in` lives outside OpenCueWeb's build context, so it is supplied through a `project_root` build context (see the OpenCueWeb deployment guide).

0 commit comments

Comments
 (0)