Sharpen wording in docs on passwordless SSH connection

Open
  • Is something wrong?
#48 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Search the documentation for the quoted passwordless SSH wording and read the surrounding setup instructions. Clarify whether ssh-agent is required and state what users should expect when an SSH command does not prompt for a password, then verify the rendered documentation.

Written by the indexing model from the issue text.

Description

The docs state that the user should "Set up passwordless ssh to your server. Usually this means you have ssh-agent running with your private key loaded". Does it matter if ssh-agent is not used? It would be nice with an additional sentence along the lines of "This has only been tested by using ssh-agent for passwordless access", or "As long as you have passwordless access (i.e. you are not prompted for a password when running `ssh @<ip_adress>, you are good to go.", to inform users about what they should do and expect.

Dominant language
Julia
Stars
148
Forks
17
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from JuliaWeb/RemoteREPL.jl

All issues in JuliaWeb/RemoteREPL.jl

Similar issues

More Julia issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.