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.

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

(maint) Update installation instruction for consistency SSH Runner #490

Closed
wants to merge 1 commit into from

Conversation

adiati98
Copy link
Contributor

@adiati98 adiati98 commented Oct 7, 2021

Issue

Closes #484

Procedure

I replaced the shorthand options with their full equivalents and added green highlighting to the environment variables.

Reference
https://docs.drone.io/runner/ssh/installation/

drone-ssh-installation

--restart always \
--name runner \
drone/drone-runner-ssh
```
Copy link
Member

Choose a reason for hiding this comment

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

@tphoney thoughts on which is more clear, the left or the right? I feel like I started using the example on the left because it was more effective to see real-world value and people were confused by the {{variable}} notation but it has been sol long I can't remember.

Copy link
Contributor

Choose a reason for hiding this comment

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

@bradrydzewski could we perhaps do a mix of the two? highlight the real world example to draw attention without the {{variable}} syntax?

@MarieReRe MarieReRe changed the title Update installation instruction for consistency (maint) Update installation instruction for consistency SSH Runner Oct 8, 2021
@tphoney
Copy link
Contributor

tphoney commented Oct 12, 2021

Hi @adiati98 thanks for bringing this to our attention its tricky to make it intuitive, we spent some time coming up with a better format and i took your change and made some tweaks #493 was merged. (your commit is still merged)

thanks again 🌈

@tphoney tphoney closed this Oct 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants