Skip to content

Docs V1: fix copy-paste issue and minor wording changes#7033

Open
rahulshendre wants to merge 2 commits into
pipe-cd:masterfrom
rahulshendre:docs/fix-v1-quickstart
Open

Docs V1: fix copy-paste issue and minor wording changes#7033
rahulshendre wants to merge 2 commits into
pipe-cd:masterfrom
rahulshendre:docs/fix-v1-quickstart

Conversation

@rahulshendre

Copy link
Copy Markdown
Contributor

What this PR does:
It removes the $ prompt prefixes from the curl and kubectl get pod commands so they copy-paste cleanly along with minor changes

Why we need it:
Part of the ongoing v1 docs cleanup

Which issue(s) this PR fixes:

Does this PR introduce a user-facing change?:

  • How are users affected by this change:
  • Is this breaking change:
  • How to migrate (if breaking change):

Signed-off-by: rahulshendre <rahulshendre789@gmail.com>
![A successfully registered `piped`](/images/quickstart-piped-registered.png)

You need to copy two values, ``piped Id`` and ``Base64 Encoded piped Key``, and fill in `<COPIED_PIPED_ID>` and `<COPIED_ENCODED_PIPED_KEY>` respectively in this command:
> **Note:** The `piped Id` is the UUID generated after you click `Save` (for example, `7c17c8f8-...`), not the name you entered while registering. Using the name instead of the UUID causes an `unable to find piped from datastore` error in the piped logs.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

it's easy to paste the piped name instead of the generated UUID here, and that fails with unable to find piped from datastore in the piped logs with no hint why, I ran into it myself once.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant