myriad clone instructions : validate ssh-add
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 2k
- Forks
- 511
- Avg merge
- 11h 23m
- Merged PRs (30d)
- 2
Description
We had a setup issue where the myriad instructions to clone a challenge were failing because the student failed to correctly add their ssh key. The git push command was not returning any error but taking infinite time.
The solution used was to add ssh-agent to the list of oh-my-zsh plugins.
But an easier solution would be to verify at the end of the setup that the student has a correct configuration :
- bad conf :
➜ repo git:(master) ssh-add -l
The agent has no identities.
- good conf :
➜ repo git:(master) ssh-add -l
256 SHA256:xxxxxxxxxxxxxxxxxxxxxxxxx gmanchon@gmail.com (ED25519)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Find the setup instructions covering how students clone a myriad challenge and read the surrounding SSH setup steps. Check how ssh-add -l behaves for an unconfigured and configured agent, then update the instructions so the final validation and expected outputs are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, shell
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100