Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion platform/control-plane/access-control/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Prefer SSO for people. A local account has its own password and does not follow

Select a user to open their page. The header shows the avatar, name, status, provider and email, with **Disable** (or **Enable**) and **Delete**. A local account also has **Reset password**: *Set a new password for this local account. Their existing sessions are signed out immediately.*

![The page of Farid Haddad: details, two platform roles and one group](/img/platform/admin/cp-user-detail.png)
![The page of Farid Haddad: details, his directly granted platform role and one group](/img/platform/admin/cp-user-detail.png)

### Details

Expand Down
2 changes: 1 addition & 1 deletion platform/data-api/endpoints/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 8

Consumers never see your draft. They see a **version**: a frozen snapshot of the endpoint's contract (SQL, parameters, response settings, cache, limits and rate limit) taken when you press **Publish**. You can edit the draft as much as you like without affecting anyone, and go back to an earlier version in one click.

![The Versions tab of Orders by status: v2 Live with a 1 breaking change badge over its note, and v1 with Roll back](/img/platform/data-api/endpoint-versions.png)
![The Versions tab of Orders by status: v2 Live with a 1 breaking change badge beside its note, and v1 with Roll back](/img/platform/data-api/endpoint-versions.png)

## Publish an endpoint

Expand Down
4 changes: 2 additions & 2 deletions platform/workspace-settings/roles-and-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ sidebar_position: 3

**Workspace settings → Access → Roles & permissions** shows what each workspace role can do in this workspace. It is a read-only view: roles are defined once for the whole platform and apply to every workspace.

![The workspace Roles and permissions page with three built-in roles and two custom roles](/img/platform/admin/ws-roles.png)
![The workspace Roles and permissions page with the three built-in roles and the custom roles, each with its permission count](/img/platform/admin/ws-roles.png)

*Roles are defined platform-wide in Control Plane → Access control and apply to every workspace. This is a read-only view.*
*Roles are defined platform-wide in Control Plane → Access control and apply to every workspace. This is a read-only view. The Control Plane also lists `data_api_invoker`: it is granted on one Data API endpoint, never as a workspace role, so it is not shown here.*

## The summary

Expand Down
2 changes: 2 additions & 0 deletions scripts/screenshots.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ if (STATE) await ctx.storageState({path: STATE});

for (const s of shots) {
if (s.id === 'login' || !wanted(s.id)) continue;
// A shot that sets a taller viewport in prepare() must not leak it into the next one.
await page.setViewportSize({width: 1440, height: 900});
await page.goto(`${BASE}${s.path}`, {waitUntil: 'networkidle'});
if (s.prepare) await s.prepare(page);
await page.waitForTimeout(s.settle ?? 800);
Expand Down
3 changes: 2 additions & 1 deletion scripts/shots/alerts.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
// Run scripts/seed-dashboards.mjs and then `scripts/seed-alerts.mjs --run` first, so the lists, run logs
// and the Mailpit inbox have content. Mail shots read Mailpit (MAILPIT, default http://localhost:8025):
// the demo stack delivers every mail there.
const ws = '/explore/default';
// DOCS_WS picks the workspace the Explore objects live in (default: `default`).
const ws = `/explore/${process.env.DOCS_WS ?? 'default'}`;
// The alert whose run log alerts/run-log shows (RUN_LOG_ALERT overrides it).
const RUN_LOG_ALERT = process.env.RUN_LOG_ALERT ?? 'Pending orders above 100';
const MAILPIT = process.env.MAILPIT ?? 'http://localhost:8025';
Expand Down
3 changes: 2 additions & 1 deletion scripts/shots/charts.mjs
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
// Screenshots for platform/explore/charts/*. Charts and datasets come from scripts/seed-charts-deep.mjs;
// folders, bookmarks and the trashed chart from scripts/seed-sql-charts-lists.mjs.
// Every prepare() starts on the Charts list, finds the chart by its exact name, and opens the wanted tab.
const ws = '/explore/default';
// DOCS_WS picks the workspace the Explore objects live in (default: `default`).
const ws = `/explore/${process.env.DOCS_WS ?? 'default'}`;
const PANEL = 'div[class*="w-[400px]"]';

const open = (name, tab, then) => async (page) => {
Expand Down
3 changes: 2 additions & 1 deletion scripts/shots/dashboards.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Screenshots for the Dashboards docs (platform/explore/dashboards/*). Run scripts/seed-dashboards.mjs first.
// Every prepare() starts from the Dashboards list, opens a dashboard by name and drives the UI from there.
const ws = '/explore/default';
// DOCS_WS picks the workspace the Explore objects live in (default: `default`).
const ws = `/explore/${process.env.DOCS_WS ?? 'default'}`;
const link = (page, name) => page.getByRole('link', {name, exact: true}).first();
const open = (name) => async (page) => {
// The auto-apply switch is a per-dashboard browser preference; start every shot from the default (on).
Expand Down
3 changes: 2 additions & 1 deletion scripts/shots/data-api.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Screenshots for the Data API and Alerts & reports pages (Apps: scripts/shots/apps.mjs).
// Data API objects are created by scripts/seed-data-api.mjs (TRAFFIC=1 also fills Activity).
const ws = '/explore/default';
// DOCS_WS picks the workspace the Explore objects live in (default: `default`).
const ws = `/explore/${process.env.DOCS_WS ?? 'default'}`;
const A = 'data-api';
const tall = (h) => (page) => page.setViewportSize({width: 1440, height: h});

Expand Down
3 changes: 2 additions & 1 deletion scripts/shots/sql-datasets.mjs
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
// Screenshots for the SQL Lab and Datasets & metrics pages (area: sql-datasets).
// Objects used here are created by scripts/seed-sql-datasets.mjs (datasets "Orders with customers" and
// "Line items", saved queries, snippets, charts, query history).
const ws = '/explore/default';
// DOCS_WS picks the workspace the Explore objects live in (default: `default`).
const ws = `/explore/${process.env.DOCS_WS ?? 'default'}`;

// ---------------------------------------------------------------- SQL Lab helpers
// Replace the editor text.
Expand Down
Binary file modified static/img/platform/admin/cp-audit-log.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/admin/cp-engine-catalogs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/admin/cp-engine-workspaces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/admin/cp-user-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/admin/cp-users-bulk.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/admin/ws-add-member.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/admin/ws-members.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/admin/ws-roles-expanded.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/admin/ws-roles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/alerts/alerts-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/alerts/detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/charts/editor-export.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/charts/gauge-display.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/charts/progress-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/charts/row-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/charts/scalar-display.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/charts/table-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/control-plane-access-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/dashboards/card-export.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/data-api/endpoint-access.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/data-api/endpoint-params.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/data-api/endpoint-versions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/sql-datasets/datasets-row-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/sql-datasets/ds-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/platform/sql-datasets/ds-usage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading