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

Remove references to cli/cmd-options.mdx #3122

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

Remove references to cli/cmd-options.mdx #3122

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8a2cddf
remove references to cmd-options.mdx
yuandrew Oct 2, 2024
abad3e6
Merge branch 'main' into remove-cmd-optons-references
yuandrew Oct 2, 2024
0da4b8d
Merge branch 'main' into remove-cmd-optons-references
fairlydurable Oct 3, 2024
56e2c26
remove duplicate entries
yuandrew Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/encyclopedia/dataconversion.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ The Temporal CLI and the Web UI in turn provide built-in hooks to call the Codec
You can perform some operations on your Workflow Execution using the Temporal CLI and the Web UI.
For example. you can start or signal an active Workflow Execution from the Temporal CLI or cancel a Workflow Execution from the Web UI, which might require inputs that contain sensitive data.

To encode this data, [specify your Codec Server endpoints](#codec-server) with [the Temporal CLI](/cli/cmd-options#codec-endpoint) and configure your Web UI to use the Codec Server endpoints.
To encode this data, [specify your Codec Server endpoints](#codec-server) with the `codec-endpoint` parameter in [the Temporal CLI](/cli) and configure your Web UI to use the Codec Server endpoints.
yuandrew marked this conversation as resolved.
Show resolved Hide resolved

#### Decoding data on the Web UI and CLI

Expand Down
2 changes: 1 addition & 1 deletion docs/encyclopedia/namespaces.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Namespaces are created on the Temporal Service, and provide a range of controls
For example, when a Workflow Execution is spawned, it does so within a specific Namespace.
- **Uniqueness:** Temporal guarantees a unique Workflow Id within a Namespace.
Workflow Executions may have the same Workflow Id if they are in different Namespaces.
- **Namespace Configuration:** Various configuration options like the [Retention Period](/clusters#retention-period) and the [Archival](/clusters#archival) destination are configured per Namespace through a special CRUD API or through the [Temporal CLI](/cli/cmd-options#namespace).
- **Namespace Configuration:** Various configuration options like the [Retention Period](/clusters#retention-period) and the [Archival](/clusters#archival) destination are configured per Namespace through a special CRUD API or through the [Temporal CLI](/cli).

### Registration

Expand Down
4 changes: 0 additions & 4 deletions vercel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1739,10 +1739,6 @@
"source": "/tctl-next/workflow#reset",
"destination": "/cli/workflow#reset"
},
{
"source": "/tctl-next/modifiers#--event-id",
Copy link
Author

Choose a reason for hiding this comment

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

@fairlydurable I'm not seeing any references to /tctl-next outside of vercel.json, would it be appropriate to remove all of the tctl-next references in this file?

Copy link
Contributor

Choose a reason for hiding this comment

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

I would not recommend messing with any tctl redirects at this time. tctl was our workhorse for years and many sources still link in.

Copy link
Author

Choose a reason for hiding this comment

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

got it, any objection to pointing it to the broad /ci/index page then? There doesn't seem to be a better replacement path for this that I can see

Copy link
Contributor

Choose a reason for hiding this comment

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

Linking to /cli/cmd-options#event-id is semantically connected to what that inbound link is looking for. It gets them to the right revised place. I'm going to say it really depends on how we re-structure the page for clarity and concision. If there is a semantic equivalent, we should always do that. If that anchor goes away, then we can be less specific if it still gets them close to that information.

Copy link
Contributor

Choose a reason for hiding this comment

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

Feedback from team: "Until we no longer support a feature or product, we’ll keep the documentation around and keep redirects in place as needed." No changes to redirects for now.

Copy link
Author

Choose a reason for hiding this comment

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

Got it, since the anchor is going away, I think /cli is the closest we can get to this information (although with this link not existing today, it's not clear what information it's trying to link anyways).

I'm also removing a duplicate set of redirects, it looks like the same source URLs occur twice in this file.

Copy link
Contributor

Choose a reason for hiding this comment

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

image

"destination": "/cli/cmd-options#event-id"
},
{
"source": "/kb/additional-resources",
"destination": "/kb/how-to-explain-temporal"
Expand Down