Add more details about how to use private repositories
The section about using private repositories in the documentation needs to be expanded. Specifically, the documentation should emphasize that Antora requires the use of the ssh repository URL (e.g., git@github.com:org/repo
), not the https repository URL (e.g., https://github.com/org/repo
). The documentation should show an example of a playbook using an ssh URL just to drive the point home.
Also emphasize that the SSH agent requirement is the exact same require to use a private repository with git. We want to drive home the point that Antora is not doing anything different than git. This should make the operator / author feel more comfortable about it.
Edited by Dan Allen