pipeline icon indicating copy to clipboard operation
pipeline copied to clipboard

SSH Auth docs improvement

Open k0dard opened this issue 11 months ago • 5 comments

Changes

Some small changes in the ssh auth part of the docs:

  • Some commands concerning generating ssh keys were misleading (cat is used for viewing files and not generating ssh keys)
  • Added formatting for ssh-privatekey and known-hosts keys
  • Added instructions on how to get known-hosts value for GitHub

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • [x] Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • [x] Has Tests included if any functionality added or changed
  • [ ] pre-commit Passed
  • [ ] Follows the commit message standard
  • [ ] Meets the Tekton contributor standards (including functionality, content, code)
  • [x] Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • [x] Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • [x] Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

k0dard avatar Jan 22 '25 13:01 k0dard

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: To complete the pull request process, please assign afrittoli after the PR has been reviewed. You can assign the PR to them by writing /assign @afrittoli in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

tekton-robot avatar Jan 22 '25 13:01 tekton-robot

Hi @k0dard. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

tekton-robot avatar Jan 22 '25 13:01 tekton-robot

/kind documentation

k0dard avatar Jan 22 '25 13:01 k0dard

/ok-to-test

waveywaves avatar Apr 01 '25 07:04 waveywaves