From cd2248c9bdd1a8868da8fc166ea99bf3840692db Mon Sep 17 00:00:00 2001 From: Sacha Chua Date: Tue, 26 Mar 2024 14:33:35 -0400 Subject: Update editing instructions --- edit.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/edit.md b/edit.md index bf6687fc..507feca3 100644 --- a/edit.md +++ b/edit.md @@ -10,21 +10,21 @@ encouraged to edit and help improve the site. proceeding further and making any changes to the wiki. To edit the wiki, you need to install `git` if it is not installed on -your machine already. Then, you can clone the sources from any one of -the following addresses: +your machine already. After you do the first-time SSH setup below, +you can clone the sources from any one of the following addresses: - ssh://anon@git.emacsconf.org:emacsconf-wiki + anon@git.emacsconf.org:pub/emacsconf-wiki git://git.emacsconf.org/emacsconf-wiki https://git.emacsconf.org/emacsconf-wiki Note that the `https://` access is read-only and does not allow -pushing changes, while the `ssh://` and `git://` methods allow pushes +pushing changes, while the `git@` (SSH) and `git://` methods allow pushes as well. Even though `https://` access is read-only, it can be useful if you would like to manually cross-check and compare the hashes of commits with hashes of the commits of a clone over the insecure `git://` protocol. -We strongly recommend using `ssh://` (which is both secure and allows +We strongly recommend using `git@git.emacsconf.org` (which is both secure and allows pushes), and avoiding `git://` (no transport security) and `https://` (read-only access) when possible. @@ -173,6 +173,18 @@ course, can be reversed by making a series of new changes that reverse the current changes. Git even has a `revert` subcommand just for that (see `man git-revert`). +## Note to EmacsConf admins + +If you need to add or update files that are normally restricted by the pre-receive hook, modify your `~/.ssh/config` to specify the `User` (and optionally `IdentityFile`) that's registered in the gitolite configuration, and add a remote with `git remote add trusted git@git.emacsconf.org:pub/emacsconf-wiki`. Then you should be able to push your changes with `git push trusted master`. + +To do this on a temporary basis, override `GIT_SSH_COMMAND` like so: + +``` +GIT_SSH_COMMAND='ssh -i ~/.ssh/id_rsa' git clone git@git.emacsconf.org:pub/emacsconf-wiki +``` + +You can confirm your access with `ssh git@git.emacsconf.org`, which should list the different repositories you have access to. + ## Have questions? If you have any questions, or are having trouble pushing your changes -- cgit v1.2.3