Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

EDU-3400: Update Nexus docs #3196

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

EDU-3400: Update Nexus docs #3196

wants to merge 15 commits into from

Conversation

prasek
Copy link
Contributor

@prasek prasek commented Nov 5, 2024 •
edited
Loading

What does this PR do?

  • Split out separate pages for nexus cloud prod guide + cleanup
  • Split out Nexus encyclopedia pages + cleanup
  • Updated Nexus overview diagrams

@prasek prasek requested a review from a team as a code owner November 5, 2024 08:30
fairlydurable
fairlydurable reviewed Nov 5, 2024
View reviewed changes
docs/evaluate/development-production-features/temporal-nexus.mdx Outdated
- Operation lifecycle and error info in Workflow Event History.
- Bi-directional linking for end-to-end debugging across Namespaces.
- Metrics, traces, and logs.
- **Improved blast radius isolation**:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love this phrase.

fairlydurable
fairlydurable reviewed Nov 5, 2024
View reviewed changes
docs/production-deployment/cloud/nexus/getting-started.mdx
@@ -45,7 +47,7 @@ New Nexus requests will be routed to the new target Namespace, and existing Nexu

1. Hide service implementations behind a Nexus Endpoint.
1. Add Nexus Services to the same Workers as the Temporal primitives being abstracted.
2. Add Nexus Endpoints to the Nexus API Registry, with monolithic Namespace as the target.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great place to(not this line, obviously, but this area) to talk about another great Nexus feature -- the gradual adoption to better architecture outcomes over time.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. Will add that in a future PR.

jsundai
jsundai reviewed Nov 5, 2024
View reviewed changes
Copy link
Contributor

@jsundai jsundai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First set of comments. Will look more tomorrow.

docs/develop/go/temporal-nexus.mdx Outdated Show resolved Hide resolved
docs/encyclopedia/temporal-nexus-registry-endpoints.mdx Outdated Show resolved Hide resolved
docs/evaluate/development-production-features/index.mdx Outdated
@@ -33,7 +33,7 @@ Through a Temporal SDK, Temporal provides a wide range of features that enable d
- **[Interrupt a Workflow](/evaluate/development-production-features/interrupt-workflow)**: Cancel or terminate a business process (Workflow) that is already in progress and compensate for any steps already taken.
- **Runtime safeguards**: Prevent avoidable errors and issues from executing during runtime.
- **[Failure detection and mitigation](/evaluate/development-production-features/failure-detection)**: Detect failures with timeouts and configure automatic retries to mitigate them.
- **[Temporal Nexus](/nexus)**: Temporal Nexus enables durable execution across team and namespace boundaries and promotes a modular architecture that enables each team to have their own namespace for improved security, troubleshooting, and blast radius isolation.
- **[Temporal Nexus](/evaluate/nexus)**: Nexus allows you to reliably connect Temporal Applications. It was designed with Durable Execution in mind and enables each team to have their own Namespace for improved modularity, security, troubleshooting, and fault isolation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great change.

docs/evaluate/development-production-features/temporal-nexus.mdx Outdated Show resolved Hide resolved
docs/evaluate/development-production-features/temporal-nexus.mdx Outdated Show resolved Hide resolved
docs/evaluate/development-production-features/temporal-nexus.mdx Outdated Show resolved Hide resolved
docs/evaluate/development-production-features/temporal-nexus.mdx
- **Enhance security by isolating different parts of the application**, reducing the risk and impact of potential issues.
- **Continue using familiar tools like queue-based Workers**, without the need for complex new setups or deployments.
<RelatedReadContainer>
<RelatedReadItem path="https://youtu.be/qqc2vsv1mrU?feature=shared&t=2082" text="Nexus keynote & demo - Replay video" archetype="replay-talk" />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might have to look into getting a Nexus icon here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that would be awesome!

docs/production-deployment/cloud/nexus/getting-started.mdx Outdated Show resolved Hide resolved
docs/production-deployment/cloud/nexus/index.mdx Outdated Show resolved Hide resolved
bergundy
bergundy approved these changes Nov 7, 2024
View reviewed changes
Copy link
Member

@bergundy bergundy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had a few small comments. My biggest concern is our recommendation for how to break up a monolith.

docs/encyclopedia/temporal-nexus.mdx Outdated Show resolved Hide resolved
docs/encyclopedia/temporal-nexus.mdx Outdated Show resolved Hide resolved
docs/evaluate/development-production-features/temporal-nexus.mdx Outdated Show resolved Hide resolved
docs/production-deployment/cloud/nexus/use-cases.mdx Outdated Show resolved Hide resolved
docs/production-deployment/cloud/nexus/use-cases.mdx Outdated Show resolved Hide resolved
@prasek prasek mentioned this pull request Nov 8, 2024
Merged
bergundy
bergundy reviewed Nov 20, 2024
View reviewed changes
docs/encyclopedia/nexus-errors-retries.mdx Outdated Show resolved Hide resolved
docs/encyclopedia/nexus-errors-retries.mdx Show resolved Hide resolved
docs/encyclopedia/nexus-errors-retries.mdx Outdated Show resolved Hide resolved
docs/encyclopedia/nexus-execution-debugging.mdx Outdated Show resolved Hide resolved
docs/encyclopedia/nexus-execution-debugging.mdx Outdated Show resolved Hide resolved
docs/encyclopedia/nexus.mdx Outdated Show resolved Hide resolved
docs/encyclopedia/nexus.mdx Outdated Show resolved Hide resolved
docs/encyclopedia/nexus-use-cases.mdx Outdated Show resolved Hide resolved
docs/encyclopedia/nexus-use-cases.mdx Outdated Show resolved Hide resolved
docs/encyclopedia/nexus-services.mdx Outdated Show resolved Hide resolved
@fairlydurable fairlydurable changed the title Update Nexus docs EDU-3400: Update Nexus docs Nov 21, 2024
@prasek
address feedback and add diagrams
f1a127f 
Signed-off-by: Phil Prasek <[email protected]>
@prasek
fix apostrophes
5c5378b 
Signed-off-by: Phil Prasek <[email protected]>
@prasek
address feedback and update metrics/latency
e920521 
Signed-off-by: Phil Prasek <[email protected]>
@prasek
update diagrams
c4505c4 
Signed-off-by: Phil Prasek <[email protected]>
@prasek
address feedback
abd3410 
Signed-off-by: Phil Prasek <[email protected]>
@prasek
Copy link
Contributor Author

prasek commented Nov 22, 2024

Addressed all feedback and will take a pass at further tightening things up in the Cloud prod guide and Encyclopedia.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bergundy bergundy bergundy approved these changes

@fairlydurable fairlydurable Awaiting requested review from fairlydurable

@jsundai jsundai Awaiting requested review from jsundai

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@prasek @bergundy @jsundai @fairlydurable