Skip to content

Commit 02a0cdb

Browse files
authored
feat(event history): replaced photo carousels with interactive demos (#5028)
* feat(event history): replaced photo carousels with interactive demos for Go * feat(event history): replaced photo carousels with interactive walkthroughs for .net; refactored components for use with multiple languages * feat(event history): replaced photo carousels with interactive walkthroughs for java * feat(event history): replaced photo carousels with interactive walkthroughs for python * feat(event history): replaced photo carousels with interactive walkthroughs for typescript * feat(event history): removed the PhotoCarousel component * chore(merge): cleaned up files after rebase with main * chore(style): minor nit to make code highlight expand width of content
1 parent 4c465e3 commit 02a0cdb

34 files changed

Lines changed: 2226 additions & 1425 deletions

COMPONENTS.md

Lines changed: 0 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ Whether you’re using core components or experimenting with new ones, this guid
2121
- [Using IntegrationsGrid](#using-integrationsgrid)
2222
- [Using CaptionedImage](#using-captionedimage)
2323
- [Using DocsTable](#using-docstable)
24-
- [Using PhotoCarousel](#using-photocarousel)
2524
- [Using RelatedRead](#using-relatedread)
2625
- [Using ToolTipTerm](#using-tooltipterm)
2726
- [Using SdkGuideLinks](#using-sdkguidelinks)
@@ -312,66 +311,6 @@ Archetypes:
312311
- feature-guide
313312
- feature-summary
314313

315-
## Using PhotoCarousel
316-
317-
Role: Provide annotated walk-through using an image carousel presentation with text.
318-
319-
How to import:
320-
321-
```
322-
import { PhotoCarousel } from '@site/src/components';
323-
```
324-
325-
or
326-
327-
```
328-
import PhotoCarousel from "@site/src/components/elements/PhotoCarousel";
329-
```
330-
331-
Usage:
332-
333-
```
334-
<PhotoCarousel
335-
images={[
336-
"/link/to/image-1",
337-
"/link/to/image-2",
338-
...
339-
]}
340-
captions={[
341-
"caption-1",
342-
"caption-2",
343-
...
344-
]}
345-
/>
346-
```
347-
348-
- If links are stored on-site, place images in static in an appropriately themed folder.
349-
- If links are stored off-site, use a fully specified URL
350-
- Please ensure the caption count and order matches that of the images
351-
- You may pass an optional `isDarkMode` Boolean prop
352-
353-
### Skipping captioning
354-
355-
To skip slide captioning, pass the string `"NA"` instead of a normal description.
356-
357-
```
358-
<PhotoCarousel
359-
images={[
360-
"/link/to/image-1",
361-
"/link/to/image-2",
362-
...
363-
]}
364-
captions={[
365-
"NA",
366-
"caption-2",
367-
...
368-
]}
369-
/>
370-
```
371-
372-
Photo 1 will not have a caption but photo 2 will have a caption.
373-
This ensures photo 2 won't be matched with caption 1.
374-
375314
## Using ToolTipTerm
376315

377316
Role: Provide definitions or background information at the point of use.

COMPONENT_REGISTRY.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,15 @@
22

33
Generated by `scripts/audit-components.mjs`. Run to update.
44

5-
**Coverage: 36/44 (82%)**
5+
**Coverage: 40/48 (83%)**
66

77
| Component | File Count | Strategy | Covered |
88
|-----------|------------|----------|---------|
99
| `TabItem` | 82 | `tabitem` ||
1010
| `Tabs` | 81 | `tabs` ||
11-
| `ReleaseNoteHeader` | 72 | `release-note-header` ||
11+
| `ReleaseNoteHeader` | 71 | `release-note-header` ||
1212
| `NoZoom` | 60 | `UNKNOWN` ||
1313
| `RelatedReadContainer` | 23 | `related-read-container` ||
14-
| `ViewSourceCodeNotice` | 23 | `view-source-code-notice` ||
1514
| `RelatedReadItem` | 20 | `related-read-item` ||
1615
| `SetupSteps` | 14 | `setup-steps` ||
1716
| `SetupStep` | 14 | `setup-step` ||
@@ -20,7 +19,12 @@ Generated by `scripts/audit-components.mjs`. Run to update.
2019
| `SdkTabs` | 9 | `sdk-tabs` ||
2120
| `CallToAction` | 8 | `call-to-action` ||
2221
| `CaptionedImage` | 7 | `captioned-image` ||
22+
| `ViewSourceCodeNotice` | 6 | `view-source-code-notice` ||
2323
| `IntegrationsGrid` | 6 | `integrations-grid` ||
24+
| `CodeToCommandsDemo` | 5 | `strip-block` ||
25+
| `CommandsToEventsDemo` | 5 | `strip-block` ||
26+
| `HistoryReplayDemo` | 5 | `strip-block` ||
27+
| `NonDeterminismDemo` | 5 | `strip-block` ||
2428
| `ToolTipTerm` | 4 | `tooltip-term` ||
2529
| `JsonTable` | 3 | `json-table` ||
2630
| `AWSRegions` | 2 | `transclude` ||

MARKDOWN_PIPELINE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,6 @@ Each component maps to a strategy in `COMPONENT_REGISTRY` (in `scripts/mdx-to-md
128128
| `CodeSnippet` | `code-snippet` | Fenced code block using the `language` prop |
129129
| `CaptionedImage`, `EnlargeImage`, `Components.CaptionedImage` | `captioned-image` | `![alt or caption or title](src)` |
130130
| YouTube/`<iframe>` embeds (often in a styled `<div>`) | strip | Removed; keep a markdown Watch link in surrounding tip/prose for LLMs |
131-
| `PhotoCarousel` | `photo-carousel` | One `![caption](url)` per entry in the `images`/`captions` arrays |
132131
| `CallToAction` | `call-to-action` | `- [h3 title](href): p description` |
133132
| `ReleaseNoteHeader` | `release-note-header` | `> **Public Preview** — Go, Java…` availability note + body blockquote. The self-closing form (`<ReleaseNoteHeader … />`) emits just the note and leaves the page body intact. |
134133
| `RelatedReadContainer` / `RelatedReadItem` | `related-read-container` / `related-read-item` | `**Related:**` Markdown link list |

docs/develop/go/workflows/basics.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ tags:
1111
- Temporal SDKs
1212
---
1313

14-
import { ViewSourceCodeNotice } from '@site/src/components';
15-
1614
## How to develop a basic Workflow {/* #develop-workflows */}
1715

1816
Workflows are the fundamental unit of a Temporal Application, and it all starts with the development of a [Workflow Definition](/workflow-definition).

docs/develop/go/workflows/cancellation.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ tags:
1616
- Temporal SDKs
1717
---
1818

19-
import { ViewSourceCodeNotice } from '@site/src/components';
20-
2119
This page shows the following:
2220

2321
- How to handle a Cancellation request within a Workflow.

docs/develop/go/workflows/schedules.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ tags:
1313
description: Schedule Workflows, start them with delays or as Temporal Cron Jobs using the Go SDK. Master scheduling, backfilling, pausing, deleting, and updating Workflows.
1414
---
1515

16-
import { ViewSourceCodeNotice } from '@site/src/components';
17-
1816
This page shows how to do the following:
1917

2018
- [Scheduled Workflows](#schedule-a-workflow)

docs/develop/python/activities/execution.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ tags:
1111
- Activity
1212
---
1313

14-
import { ViewSourceCodeNotice } from '@site/src/components';
15-
1614
## Start an Activity Execution {/* #activity-execution */}
1715

1816
**How to start an Activity Execution using the Temporal Python SDK.**

docs/develop/python/activities/timeouts.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ tags:
1717
- Temporal SDKs
1818
---
1919

20-
import { ViewSourceCodeNotice } from '@site/src/components';
21-
2220
## Set Activity timeouts {/* #activity-timeouts */}
2321

2422
Each Activity timeout controls the maximum duration of a different aspect of an Activity Execution.

docs/develop/python/workflows/basics.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ tags:
1111
- Temporal SDKs
1212
---
1313

14-
import { ViewSourceCodeNotice } from '@site/src/components';
15-
1614
## Develop a basic Workflow {/* #develop-workflows */}
1715

1816
Workflows are the fundamental unit of a Temporal Application, and it all starts with the development of a

docs/develop/python/workflows/timers.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ tags:
1818
- Temporal SDKs
1919
---
2020

21-
import { ViewSourceCodeNotice } from '@site/src/components';
22-
2321
A Workflow can set a durable Timer for a fixed time period.
2422
In some SDKs, the function is called `sleep()`, and in others, it's called `timer()`.
2523

0 commit comments

Comments
 (0)