docs: SSH documentation in README and change to web page #314
Conversation
|
This is related to issue #313 |
|
By the way, given that I can't really contribute much besides documentation, if you want I could review the entire README file and update it. |
views/settings.tpl
Outdated
| @@ -40,7 +40,8 @@ | |||
|
|
|||
| <h4>SSH</h4> | |||
| <hr> | |||
| SSH allows you to access the command line of this machine remotely. Once your SSH public key has been added, you can connect to this server with "ssh {{username}}@{{hostname}}".<br> | |||
| To access this machine remotely, add your public SSH key by pasting it in the field below, then click on "Save" at the bottom of the page. If the operation is successful, you'll see your public key appear below the "Add public key" field once tha page reloads. For more details, please refer to <a href="https://github.com/ChimeraOS/chimera/blob/master/README.md">the README file of the Github repository</a>.<br> | |||
There was a problem hiding this comment.
My concern with this is that it is too long of a description. Perhaps we could make this message a tooltip/popup?
There was a problem hiding this comment.
The rest of this PR is great, so perhaps at the very least, you could split this part out into a separate PR.
There was a problem hiding this comment.
Perhaps we could make this message a tooltip/popup?
HTML isn't exactly my thing. This was an easy enough edit even without being able to properly preview the end result. I wouldn't know how to make anything prettier than this.
In principle I don't disagree. But I would argue that a longer description doesn't hurt, while someone else works on a nicer implementation.
you could split this part out into a separate PR
Pardon my ignorance, but how would I do that? Make a new commit on this branch that skips this file, and then create a new branch just for this file?
There was a problem hiding this comment.
We could also opt for a middle-of-the-road solution, and go for:
SSH allows you to access the command line of this machine remotely. Once your SSH public key has been added, you can connect to this server with "ssh {{username}}@{{hostname}}".
For more details, please refer to the README file of the Github repository.
There was a problem hiding this comment.
We could also opt for a middle-of-the-road solution, and go for:
SSH allows you to access the command line of this machine remotely. Once your SSH public key has been added, you can connect to this server with "ssh {{username}}@{{hostname}}".
For more details, please refer to the README file of the Github repository.
Yes, that works.
| @@ -4,3 +4,4 @@ __pycache__/ | |||
| venv/ | |||
| .pybuild | |||
| *.egg-info | |||
| *.code-workspace | |||
There was a problem hiding this comment.
@alkazar I hope this is not a problem.
|
Nice work, thank you! |
Hi there!
I hope I am not overstepping any boundaries here. 😁
Here's a changelog:
.markdownlint.jsonfileNote that I did not test how the changes to the HTML page will render, as I didn't have an easy way to do so.
Cheers,