Update SSH Agent FAQ for Windows #96
Conversation
|
@phoerious @droidmonkey should we just remove the outdated FAQ entries (not all) and point people to the docs? I don't think maintaining the FAQ as documentation like it was before is good use of anyone's time. @Okeanos is the actual documentation at https://keepassxc.org/docs/KeePassXC_UserGuide.html#_ssh_agent more up to date and would you be interested in working on that? The doc sources are part of the main KeePassXC repository. |
|
I would keep some FAQ, but if things can be explained better in the docs, I'm all for it. |
|
The actual documentation does indeed look better and I'd be willing to see whether I can still improve it. Reducing the FAQ and at the same time fixing some issues (like pointing out OpenSSH is supported on Windows) sounds like a good idea. |
|
I dislike the FAQ for several reasons. That page is ridiculously large and impossible to navigate. The information tends to get stale quickly. Anything that is truly "documentation" should be put in our user guide instead. FAQ should be errata, not fundamental usage tips. I dislike this change a lot because it makes the above points even worse. |
|
I now reverted most of my original changes and instead opted to enrich the existing SSH Agent information with minimal additions concerning the Windows support. If there are additional changes required before this can be merged I'd be happy to do that. I would like to see the FAQ changes merged because until a better version exists I would at least like to get rid of some inaccuracies for now. Concerning the full rewrite/change of the FAQ and updates to the real user documentation: I would personally prefer to do that in a separate pull request; especially the former currently appears to require more discussion? |
|
Documentation is edited on the keepassxc repo. https://github.com/keepassxreboot/keepassxc/tree/develop/docs |
|
I updated the pull request and added a single point concerning interaction with Git For Windows – if there particular changes I have to make before this can be merged I'd be happy to do so. |
* Update naming of `macOS` to use the official case instead of `MacOS` * Add an in depth explanation for using Windows OpenSSH (see keepassxreboot/keepassxc-org#96 for details) * Remove some trailing whitespace
|
@hifi I just noticed that this is still open and I am wondering whether there are any additional changes required or different plans altogether for the FAQ (that I might be able contribute to)? I'd appreciate some feedback, even if it's just closing/declining the pull request. |
|
@droidmonkey @hifi I updated the pull request to resolve the conflicts with the current master. If there's anything else I need to change for this to get merged, please let me know. |
|
Ah, sorry. I'll read these through and merge if nothing stands out. Thanks! |
Previously Windows' own OpenSSH option was not mentioned, even though KeePassXC supports it. Different Windows options are explicitly mentioned some inaccurate statements have been rephrased or enriched with some additional context. Add an FAQ entry for using KeePassXC SSH Agent integration with Git for Windows and a caveat for the unsupported Git bundled OpenSSH.
|
@hifi good to go? |
Previously Windows' own OpenSSH option was not mentioned, even though KeePassXC supports it.
Additionally, to better differentiate between the two major platforms (Unix vs. Window) and their differences they now each have a separate section.
Some additional comments:
I removed the line following line from the
Why is Pageant refusing my keys?-question:Because from a cursorily glance at the Win32 OpenSSH issues there may be options to correctly provide and configure
SSH_ASKPASSwhen using Windows' own OpenSSH binaries. I haven't verified that.There is "a lot" of duplication between the two sections – yeah, that's true. It might be useful to split that into a generalised third section. Thoughts?
It might be worth a shot to add a question/answer pair outlining the "use KeePassXC together with Git for Windows" workaround/solution I referred to in keepassxc#4681.
Assuming any changes have to be made to get this merged … I assume you want all of this in a single commit?
As an aside, unrelated to this pull request: My IDE and I noticed some trailing whitespaces throughout the file and generally inconsistent formatting (e.g.
<br>vs<br />) and some technical problems (such as missing references e.g. to#faq-string-fieldsor wrongly nested HTML elements<ul>inside of<ul>instead of<li>). Would you be interested in a separate pull request that fixes these things?