add preview and related reads components #673
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
flossypurse
approved these changes
Oct 8, 2021
swyxio
commented
Oct 8, 2021
Comment on lines
-43
to
+48
| <RelatedReadList | ||
| readlist={[ | ||
| ["What is a Workflow Id?","/docs/content/what-is-a-workflow-id","explanation"], | ||
| ]} | ||
| /> | ||
| <!-- prettier-ignore --> | ||
| import * as WWID from './what-is-a-workflow-id.md' | ||
|
|
||
| <RelatedReadContainer> | ||
| <RelatedReadItem page={WWID} /> | ||
| </RelatedReadContainer> |
There was a problem hiding this comment.
example conversion of RelatedReadList
swyxio
commented
Oct 8, 2021
Comment on lines
-129
to
+134
| - **Performance**: Keep in mind that all parameters and return values are recorded in the [Workflow Execution Event History](/docs/content/what-is-an-event-history). | ||
| A large Workflow Execution Event History can adversely impact the performance of your Workflow Executions, as the entire Event History is transferred to Worker Processes with every [Workflow Task](/docs/content/what-is-a-workflow-task). | ||
| <!-- prettier-ignore --> | ||
| import * as EventHistory from "./what-is-an-event-history.md" | ||
| import * as WFTask from "./what-is-a-workflow-task.md" | ||
|
|
||
| - **Performance**: Keep in mind that all parameters and return values are recorded in the <preview page={EventHistory}>Workflow Execution Event History</preview>. | ||
| A large Workflow Execution Event History can adversely impact the performance of your Workflow Executions, as the entire Event History is transferred to Worker Processes with every <preview page={WFTask}>Workflow Task</preview>. |
There was a problem hiding this comment.
example conversion of <preview> component
swyxio
commented
Oct 8, 2021
Comment on lines
-122
to
+125
| - **Description**: This is the maximum amount of time that the Server will wait for the Worker to start processing a [Workflow Task](/docs/content/what-is-a-workflow-task) after the Task has been pulled from the Task Queue. | ||
| <!-- prettier-ignore --> | ||
| import * as WorkflowTask from "../content/what-is-a-workflow-task.md" | ||
|
|
||
| - **Description**: This is the maximum amount of time that the Server will wait for the Worker to start processing a <preview page={WorkflowTask}>Workflow Task</preview> after the Task has been pulled from the Task Queue. |
There was a problem hiding this comment.
example conversion of <preview> component
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Special Preview link
import a page and add the new
<preview>tag:https://deploy-preview-673--mystifying-fermi-1bc096.netlify.app/docs/concepts/workflows#task-timeout
Related Read List
swap out
<RelatedReadList>withRelatedReadContainerandRelatedReadItem.https://deploy-preview-673--mystifying-fermi-1bc096.netlify.app/docs/content/how-to-set-startworkflowoptions-in-go/#id
If there are multiple items, the container auto switches to a bulleted list.
By default, RelatedReadItem uses the title of the page as its link text. to customize it, give it a child:
Notes to reviewers
see diffs for what to take out and what to put in. mind your imports and your closing tags. it doesnt really matter what you name the imported MDX files, just make sure you use
import * as Foo from '...'instead ofimport Foo from '...'.