Skip to content

Commit 2fceaca

Browse files
brianmacdonald-temporalbrianmacdonald-temporal
authored
Merge branch 'main' into dependabot/npm_and_yarn/fast-uri-3.1.2
2 parents a6b6e81 + 1c8767b commit 2fceaca

6 files changed

Lines changed: 261 additions & 236 deletions

File tree

‎docs/evaluate/temporal-cloud/actions.mdx‎

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

‎docs/references/api-reference.mdx‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
id: api-reference
3+
title: API reference
4+
sidebar_label: API reference
5+
description: Includes links to all Temporal SDK API references for Go, Java, Python, TypeScript, .NET, PHP, and Ruby.
6+
keywords:
7+
- api reference
8+
- sdk api
9+
- go api
10+
- java api
11+
- python api
12+
- typescript api
13+
- dotnet api
14+
- php api
15+
- ruby api
16+
tags:
17+
- Reference
18+
- SDK
19+
---
20+
21+
import PatternCards from '@site/src/components/PatternCards';
22+
23+
# API reference
24+
25+
Complete API documentation for all Temporal SDKs and server APIs.
26+
27+
## SDK API References
28+
29+
<PatternCards items={[
30+
{
31+
href: "https://pkg.go.dev/go.temporal.io/sdk",
32+
title: "Go SDK API",
33+
description: "Complete Go SDK API documentation on pkg.go.dev with all packages, types, and methods.",
34+
external: true,
35+
},
36+
{
37+
href: "https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/index.html",
38+
title: "Java SDK API",
39+
description: "Complete Java SDK API documentation on javadoc.io with all classes, interfaces, and annotations.",
40+
external: true,
41+
},
42+
{
43+
href: "https://php.temporal.io/namespaces/temporal.html",
44+
title: "PHP SDK API",
45+
description: "Complete PHP SDK API documentation with all namespaces, classes, and interfaces.",
46+
external: true,
47+
},
48+
{
49+
href: "https://python.temporal.io/",
50+
title: "Python SDK API",
51+
description: "Complete Python SDK API documentation with all modules, classes, and functions.",
52+
external: true,
53+
},
54+
{
55+
href: "https://ruby.temporal.io/",
56+
title: "Ruby SDK API",
57+
description: "Complete Ruby SDK API documentation with all modules, classes, and methods.",
58+
external: true,
59+
},
60+
{
61+
href: "https://typescript.temporal.io",
62+
title: "TypeScript SDK API",
63+
description: "Complete TypeScript SDK API documentation with all interfaces, types, and namespaces.",
64+
external: true,
65+
},
66+
{
67+
href: "https://dotnet.temporal.io/api/",
68+
title: ".NET SDK API",
69+
description: "Complete .NET SDK API documentation with all namespaces, classes, and methods.",
70+
external: true,
71+
},
72+
]} />
73+
74+
## Server API References
75+
76+
<PatternCards items={[
77+
{
78+
href: "/self-hosted-guide/server-frontend-api-reference",
79+
title: "Server Frontend API",
80+
description: "gRPC API reference used by Client and Worker SDKs to communicate with Temporal Server.",
81+
},
82+
]} />
83+
84+
## Need Help?
85+
86+
For questions about specific APIs, use the **Ask AI** button in the top navigation for instant answers, connect our [Model Context Protocol server](/with-ai) to AI tools for real-time documentation access, or visit our [Community Forum](https://community.temporal.io/) and [Slack](https://temporal.io/slack) for community support.

‎docs/references/index.mdx‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,12 @@ tags:
99
- Reference
1010
---
1111

12+
- [API reference](/references/api-reference)
1213
- [SDK metrics reference](/references/sdk-metrics)
1314
- [Commands reference](/references/commands)
1415
- [Events reference](/references/events)
1516
- [Web UI environment variables reference](/references/web-ui-environment-variables)
1617
- [Temporal Service configuration reference](/references/configuration)
1718
- [Temporal Web UI configuration reference](/references/web-ui-configuration)
1819
- [Temporal Cloud Operation reference](/references/operation-list)
19-
- [Go SDK API reference](https://pkg.go.dev/go.temporal.io/sdk)
20-
- [Java SDK API reference](https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/index.html)
21-
- [Python SDK API reference](https://python.temporal.io/)
22-
- [TypeScript SDK API reference](https://typescript.temporal.io)
23-
- [.NET SDK API reference](https://dotnet.temporal.io/api/)
24-
- [PHP SDK API reference](https://php.temporal.io/namespaces/temporal.html)
2520
- [Glossary](/glossary)

‎docs/security.mdx‎

Lines changed: 26 additions & 132 deletions
Original file line numberDiff line numberDiff line change
@@ -11,137 +11,31 @@ tags:
1111
- Security
1212
---
1313

14-
Find security information for your Temporal deployment, whether you're using Temporal Cloud or self-hosting.
15-
16-
<div className="pattern-grid">
17-
<a href="https://trust.temporal.io" className="pattern-card">
18-
<div className="pattern-content">
19-
<h3>Company Security</h3>
20-
<p>Learn about Temporal Technologies' general security practices, compliance certifications, and organizational security measures.</p>
21-
</div>
22-
</a>
23-
24-
<a href="/cloud/security" className="pattern-card">
25-
<div className="pattern-content">
26-
<h3>Temporal Cloud Security</h3>
27-
<p>Explore the security features of our SaaS offering, including mTLS, end-to-end encryption, and enterprise compliance.</p>
28-
</div>
29-
</a>
30-
31-
<a href="/self-hosted-guide/security" className="pattern-card">
32-
<div className="pattern-content">
33-
<h3>Self-Hosted Security</h3>
34-
<p>Discover how to deploy and secure your own Temporal Platform infrastructure with production-ready best practices.</p>
35-
</div>
36-
</a>
37-
38-
39-
<a href="https://temporal.io/pages/cloud-security-white-paper" className="pattern-card">
40-
<div className="pattern-content">
41-
<h3>Temporal Cloud Security Whitepaper</h3>
42-
<p>Learn how Temporal Cloud provides provable security by design - orchestrating encrypted workflows without ever accessing your sensitive data.</p>
43-
</div>
44-
</a>
45-
</div>
46-
47-
48-
49-
<style jsx>{`
50-
.security-cards-container {
51-
margin: 2rem 0;
52-
}
53-
54-
.security-cards-grid {
55-
display: grid;
56-
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
57-
gap: 2rem;
58-
margin-top: 2rem;
59-
}
60-
61-
.security-card {
62-
background: linear-gradient(135deg, #ffffff 0%, #fafbfc 100%);
63-
border: 1px solid #e1e8ed;
64-
border-radius: 12px;
65-
padding: 2rem;
66-
transition: all 0.3s ease;
67-
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.04);
68-
position: relative;
69-
overflow: hidden;
70-
}
14+
import PatternCards from '@site/src/components/PatternCards';
7115

72-
.security-card::before {
73-
content: '';
74-
position: absolute;
75-
top: 0;
76-
left: 0;
77-
right: 0;
78-
height: 4px;
79-
background: linear-gradient(90deg, #444ce7 0%, #b664ff 100%);
80-
}
81-
82-
.security-card:hover {
83-
transform: translateY(-4px);
84-
box-shadow: 0 8px 24px rgba(68, 76, 231, 0.12);
85-
border-color: #444ce7;
86-
}
87-
88-
.security-card-header h3 {
89-
margin: 0 0 0.5rem 0;
90-
font-size: 1.375rem;
91-
font-weight: 600;
92-
color: #1a1b23;
93-
line-height: 1.3;
94-
}
95-
96-
.security-card-divider {
97-
width: 40px;
98-
height: 3px;
99-
background: linear-gradient(90deg, #444ce7 0%, #b664ff 100%);
100-
border-radius: 2px;
101-
margin-bottom: 1.5rem;
102-
}
103-
104-
.security-card-body p {
105-
color: #5d6b7d;
106-
line-height: 1.6;
107-
margin-bottom: 1.5rem;
108-
font-size: 0.95rem;
109-
}
110-
111-
.security-card-button {
112-
display: inline-flex;
113-
align-items: center;
114-
gap: 0.5rem;
115-
color: #444ce7;
116-
text-decoration: none;
117-
font-weight: 500;
118-
font-size: 0.95rem;
119-
transition: all 0.2s ease;
120-
padding: 0.5rem 0;
121-
}
122-
123-
.security-card-button:hover {
124-
color: #3730a3;
125-
text-decoration: none;
126-
transform: translateX(2px);
127-
}
128-
129-
.security-card-button svg {
130-
transition: transform 0.2s ease;
131-
}
132-
133-
.security-card-button:hover svg {
134-
transform: translateX(2px);
135-
}
136-
137-
@media (max-width: 768px) {
138-
.security-cards-grid {
139-
grid-template-columns: 1fr;
140-
gap: 1.5rem;
141-
}
16+
Find security information for your Temporal deployment, whether you're using Temporal Cloud or self-hosting.
14217

143-
.security-card {
144-
padding: 1.5rem;
145-
}
146-
}
147-
`}</style>
18+
<PatternCards items={[
19+
{
20+
href: "https://trust.temporal.io",
21+
title: "Company Security",
22+
description: "Learn about Temporal Technologies' general security practices, compliance certifications, and organizational security measures.",
23+
external: true,
24+
},
25+
{
26+
href: "/cloud/security",
27+
title: "Temporal Cloud Security",
28+
description: "Explore the security features of our SaaS offering, including mTLS, end-to-end encryption, and enterprise compliance.",
29+
},
30+
{
31+
href: "/self-hosted-guide/security",
32+
title: "Self-Hosted Security",
33+
description: "Discover how to deploy and secure your own Temporal Platform infrastructure with production-ready best practices.",
34+
},
35+
{
36+
href: "https://temporal.io/pages/cloud-security-white-paper",
37+
title: "Temporal Cloud Security Whitepaper",
38+
description: "Learn how Temporal Cloud provides provable security by design - orchestrating encrypted workflows without ever accessing your sensitive data.",
39+
external: true,
40+
},
41+
]} />

‎sidebars.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1375,6 +1375,7 @@ module.exports = {
13751375
id: 'references/index',
13761376
},
13771377
items: [
1378+
'references/api-reference',
13781379
'references/cluster-metrics',
13791380
'references/commands',
13801381
'references/configuration',

‎src/components/PatternCards.tsx‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
import React from 'react';
2+
3+
type PatternCardItem = {
4+
href: string;
5+
title: string;
6+
description: string;
7+
external?: boolean;
8+
};
9+
10+
type PatternCardsProps = {
11+
items: PatternCardItem[];
12+
};
13+
14+
export default function PatternCards({ items }: PatternCardsProps) {
15+
return (
16+
<div className="pattern-grid">
17+
{items.map((item) => (
18+
<a
19+
key={item.href}
20+
href={item.href}
21+
className="pattern-card"
22+
{...(item.external ? { target: '_blank', rel: 'noopener noreferrer' } : {})}
23+
>
24+
<div className="pattern-content">
25+
<h3>{item.title}</h3>
26+
<p>{item.description}</p>
27+
</div>
28+
</a>
29+
))}
30+
</div>
31+
);
32+
}

0 commit comments

Comments
 (0)