jx-docs icon indicating copy to clipboard operation
jx-docs copied to clipboard

refactor: updates to use conventional placeholders for username reference

Open michaelerobertsjr opened this issue 2 years ago • 3 comments

Description

It was a bit confusing without conventional documentation placeholders. As a new user, I thought the process was creating a new separate service/user. This update to use more conventional placeholders makes it clearer that the user should insert their existing GitHub username.

Fixes # (issue)

Checklist:

  • [x ] I have mentioned the appropriate type(scope), as referenced here in the commit message and PR title for the semantic checks to pass.
  • [x ] I have signed off the commit, as per instructions mentioned here.
  • [x] Any dependent changes have already been merged.

michaelerobertsjr avatar Mar 27 '22 19:03 michaelerobertsjr

Hi @michaelerobertsjr. Thanks for your PR.

I'm waiting for a jenkins-x or todo 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 jenkins-x/lighthouse repository.

jenkins-x-bot avatar Mar 27 '22 19:03 jenkins-x-bot

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: To complete the pull request process, please assign rawlingsj You can assign the PR to them by writing /assign @rawlingsj 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

jenkins-x-bot avatar Mar 27 '22 19:03 jenkins-x-bot

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

sonarqubecloud[bot] avatar Mar 27 '22 19:03 sonarqubecloud[bot]

/ok-to-test

msvticket avatar Mar 02 '24 12:03 msvticket

/retest

msvticket avatar Mar 02 '24 13:03 msvticket

:star: PR built and available in a preview jenkins-x-jx-docs-pr-3575 here

jenkins-x-bot avatar Mar 02 '24 13:03 jenkins-x-bot

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: msvticket

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

The pull request process is described 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

jenkins-x-bot avatar Mar 02 '24 13:03 jenkins-x-bot

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: msvticket

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

The pull request process is described 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

jenkins-x-bot avatar Mar 02 '24 13:03 jenkins-x-bot