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.

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

docs: improve metamorph section #1123

Merged
merged 4 commits into from
Aug 7, 2024
Merged

docs: improve metamorph section #1123

merged 4 commits into from
Aug 7, 2024

Conversation

TC-MO
Copy link
Contributor

@TC-MO TC-MO commented Jul 28, 2024

rework logical flow & structure
added admonitions

rework logical flow & structure
added admonitions
@github-actions github-actions bot added the t-docs Issues owned by technical writing team. label Jul 28, 2024
@mtrunkat mtrunkat requested a review from fnesveda July 29, 2024 13:36
Copy link
Member

@fnesveda fnesveda left a comment

Choose a reason for hiding this comment

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

Found a few typos, plus left some suggestions 🙂


## Benefits of metamorph

Metamorph offers several advantages for developers:
Copy link
Member

Choose a reason for hiding this comment

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

Advantages over what?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm, that is true, I do not provide anything to compare Metamorph with so benefits would make more sense, since there still is a list of positives provided for developers.

TC-MO and others added 2 commits July 30, 2024 23:11
Co-authored-by: František Nesveda <fnesveda@users.noreply.github.com>
@TC-MO TC-MO requested a review from fnesveda August 5, 2024 13:14
Copy link
Member

@fnesveda fnesveda left a comment

Choose a reason for hiding this comment

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

Looks good, I just found one typo, otherwise approving


To make your Actor compatible with the metamorph operation, use `Actor.getInput()` instead of `Actor.getValue('INPUT')`. This method will fetch the input using the right key **INPUT-METAMORPH-1** in case of a metamorphed run.
The metamorph process invovles several key steps. It stops the current Actor's Docker container, then starts a new container using a different Docker image. During this transition, all default storages are preserved. The new input is stored under the _INPUT-METAMORPH-1_ key in the default key-value store, ensuring seamless data transfer between Actor runs.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The metamorph process invovles several key steps. It stops the current Actor's Docker container, then starts a new container using a different Docker image. During this transition, all default storages are preserved. The new input is stored under the _INPUT-METAMORPH-1_ key in the default key-value store, ensuring seamless data transfer between Actor runs.
The metamorph process involves several key steps. It stops the current Actor's Docker container, then starts a new container using a different Docker image. During this transition, all default storages are preserved. The new input is stored under the _INPUT-METAMORPH-1_ key in the default key-value store, ensuring seamless data transfer between Actor runs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah found it as well and was pushing commit, thank you!

@TC-MO TC-MO merged commit df25bf6 into master Aug 7, 2024
7 checks passed
@TC-MO TC-MO deleted the development-metamorph branch August 7, 2024 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t-docs Issues owned by technical writing team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants