Update CLI docs for release 779/merge #3528
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
docs/cli/activity.mdx
Outdated
| @@ -1,311 +1,961 @@ | |||
| --- | |||
| id: activity | |||
| title: Temporal CLI activity command reference | |||
| sidebar_label: activity | |||
| title: temporal activity | |||
There was a problem hiding this comment.
Note to other reviewers: lower case reflects the CLI name and command
There was a problem hiding this comment.
I assume we'll want title and sidebar_label to match what we have today?
There was a problem hiding this comment.
I don't want anyone to block you for what might look like a casing mistake
|
@brianmacdonald-temporal @yuandrew I'm so excited to see this automated PR start to come to life. I haven't checked the preview yet, but we should make sure the front matter YAML is aligned with our current Docs team policies and that the produced output looks like a docs page, not autogen. I'll let @brianmacdonald-temporal make that call.
|
|
@brianmacdonald-temporal Do you remember for the IA "what if" deployment I rewrote the installing the CLI section? It's here: https://temporal-documentation-git-edu-4213.preview.thundergun.io/build-with-temporal/setup-cli @yuandrew What do you think about this? Could we use it to replace the install page? |
What is "front matter YAML" here?
Sorry, what is the ask here? If the link should replace today's install page? That's probably something better brought up to the CLI group. From a quick look, the new page looks good |
|
@yuandrew Frontmatter is the YAML section of an MDX file that defines the file's metadata. It's at the start of the file and ends with the dashes. |
|
@yuandrew I'll bring up replacing the install with the CLI group. Who would be a good person to approach? |
|
@fairlydurable got it. With temporalio/cli#791 in, all front matter should match now! |
|
Unaligned line continuation; recommended one space at end of line before backslash 
|
|
Seems to have a code fence error 
|
|
Missing /worker link in sidebars |
# Conflicts: # docs/cli/activity.mdx
Where are you seeing this? I'm only seeing code samples with the |
|
@yuandrew I left a screenshot that was rendered from the vercel preview. Let me find the source for you |
|
@yuandrew My apologies. That screenshot is from the live docs site not the preview. Please ignore |
There was a problem hiding this comment.
I am unblocking this, will merge after OK from @yuandrew and a final Vercel inspection
|
@yuandrew Made sure this was not the live site this time. :) 
|
|
Recommending a global search for +-- 
|
|
Consider trimming overlapping content on the landing page wrt the new install / quick start page |
|
@fairlydurable we're happy to merge this! We will address the +-- and trimming duplicate setup info between the 2 pages in a follow up PR |
|
|
||
| - [--workflow-id](/cli/cmd-options#workflow-id) | ||
| **--output**, **-o** _string-enum_ |
There was a problem hiding this comment.
table with links,
we have inline definitions now,
|
Merged. Looking forward to your follow-ups |
Autogenerated PR from https://github.com/temporalio/cli