summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAmin Bandali <bandali@gnu.org>2020-07-26 03:13:40 -0400
committerAmin Bandali <bandali@gnu.org>2020-07-26 03:13:40 -0400
commitd0113d26aaa4ae0101a0bfe954c3f810413284f6 (patch)
tree3de338c3b47f90dca79211dd33b40ff43f5041a4
parent4b4b485203d8adc5ee3a54fcfcb8bbc4c7e56459 (diff)
downloademacsconf-wiki-d0113d26aaa4ae0101a0bfe954c3f810413284f6.tar.xz
emacsconf-wiki-d0113d26aaa4ae0101a0bfe954c3f810413284f6.zip
first pass at edit instructions for the wiki
-rw-r--r--edit.md99
-rw-r--r--id_rsa_anon_git_emacsconf27
2 files changed, 126 insertions, 0 deletions
diff --git a/edit.md b/edit.md
new file mode 100644
index 00000000..f43d2875
--- /dev/null
+++ b/edit.md
@@ -0,0 +1,99 @@
+This site is a wiki, editable by anyone on the planet. The pages are
+written in markdown, and converted to HTML using the
+[ikiwiki](//ikiwiki.info) wiki compiler. You are welcome and
+encouraged to edit and help improve the site.
+
+**Important:** before proceeding any further, see the [[EmacsConf wiki
+license terms|COPYING]] before pushing any changes.
+
+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:
+
+ ssh://anon@git.emacsconf.org: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
+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
+pushes), and avoiding `git://` (no transport security) and `https://`
+(read-only access).
+
+## SSH access (recommended method)
+
+To use the `ssh://` method, you need `openssh` installed on your
+machine, which is available on virtually all GNU/Linux distributions
+and other Unix-like operating systems like the BSDs. You also need to
+download the ssh private key [[id_rsa_anon_git_emacsconf]] and install
+it into `~/.ssh/` (the `.ssh` directory in your home directory). The
+key fingerprint is `SHA256:XbUoLgO2YH9+phNPKvwq8w0Q/8NhaKfS/VE6pDwTPsM
+anon@git.emacsconf.org`, and its randomart image is:
+
+ +---[RSA 2048]----+
+ | . |
+ | o . |
+ | + o . o . |
+ | . * + o o |
+ | . * S + . |
+ | + &.B.o |
+ | ..+ E=* |
+ | o.ooo@.o |
+ | +o++.. |
+ +----[SHA256]-----+
+
+Note that `openssh` requires SSH private keys to be secured with
+permissions that prevent other users on your machine from reading or
+modifying them.
+
+To download the key and set appropriate permissions on it, you run
+something along these lines in your terminal:
+
+ wget https://emacsconf.org/id_rsa_anon_git_emacsconf
+ mkdir -p ~/.ssh/
+ mv id_rsa_anon_git_emacsconf ~/.ssh/
+ chmod 600 ~/.ssh/id_rsa_anon_git_emacsconf
+
+You can show the fingerprint of the key to examine with the expected
+fingerprint mentioned ealier using:
+
+ ssh-keygen -lf ~/.ssh/id_rsa_anon_git_emacsconf
+
+Lastly, you need to create a `~/.ssh/config` file (if you don't have
+one already) and add the following to it:
+
+ Host front0.emacsconf.org
+ Port 22
+ User git
+ IdentityFile ~/.ssh/id_rsa_anon_git_emacsconf
+
+The `Port 22` line is optional, since SSH uses port 22 by default.
+However, the SSH server listens on ports 21, 22, 53, 81, 8000, and
+8080 for your convenience if you need it.
+
+You're now all set and ready to clone the repository containing the
+wiki sources. To do so, run:
+
+ git clone anon@git.emacsconf.org:emacsconf-wiki
+
+If this is your first time using Git, please set valid and real
+`user.name` and `user.email` configurations options (see [Getting
+Started - First-Time Git
+Setup](//git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup)).
+
+Now, go ahead and make your changes to the website sources in the
+repository you just cloned. When you're done, do:
+
+ git add X Y Z
+ git commit -m"descriptive commit message"
+
+where `X`, `Y`, and `Z` are the files you changes; and `descriptive
+commit message` is, well, a descriptive text describing your changes.
+When you are ready, push your changes by running `git push`, and if
+all went well, your commit should be pushed and your changes appear on
+the website within a few seconds.
diff --git a/id_rsa_anon_git_emacsconf b/id_rsa_anon_git_emacsconf
new file mode 100644
index 00000000..80147f40
--- /dev/null
+++ b/id_rsa_anon_git_emacsconf
@@ -0,0 +1,27 @@
+-----BEGIN OPENSSH PRIVATE KEY-----
+b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABFwAAAAdzc2gtcn
+NhAAAAAwEAAQAAAQEAuxNhW85GMcEiXumo5CNYPdf6M6f+kYla4RoI6xyc48Ut2J+KWHkS
+lZSK34AtpDMn6oIn96Lo3+oNLdppz83q00qs9X7MWuiVxQ38o/YnyEAQ0foohYcMHQn4PJ
+0d51TCp0CE5kjrIXI52hlt9RZezMg9VX+ABxQFilMTPx/bFhp+7EMLB8IKYCcGEMVizh3t
++dAKI3ykgBiQAjmi+tIc/iWk9bjeRP0M1x8u9/5UfRS+sn2s3JNIS8eXI+PH+g2C9WtZHW
+bAIZHyVDZLya5ST+AGKgcBrvqdl0mAZBE32KxeytKk14Yh/UXf1s6qYIOHoEMZ0Ix+VuZe
+WGMKYZurnQAAA9D3kcWF95HFhQAAAAdzc2gtcnNhAAABAQC7E2FbzkYxwSJe6ajkI1g91/
+ozp/6RiVrhGgjrHJzjxS3Yn4pYeRKVlIrfgC2kMyfqgif3oujf6g0t2mnPzerTSqz1fsxa
+6JXFDfyj9ifIQBDR+iiFhwwdCfg8nR3nVMKnQITmSOshcjnaGW31Fl7MyD1Vf4AHFAWKUx
+M/H9sWGn7sQwsHwgpgJwYQxWLOHe350AojfKSAGJACOaL60hz+JaT1uN5E/QzXHy73/lR9
+FL6yfazck0hLx5cj48f6DYL1a1kdZsAhkfJUNkvJrlJP4AYqBwGu+p2XSYBkETfYrF7K0q
+TXhiH9Rd/Wzqpgg4egQxnQjH5W5l5YYwphm6udAAAAAwEAAQAAAQEAtMUlbvEEI0/dRpnC
++bCttBTfUMsk0r1Hc/0UYRxk/jOq+Ygwxw03SBMhnpbdg61rBNCAjmp9XOFtmsFTPdpc74
+9ZUmAUWEQndSLu3gEesAI4Pq7cOSsmKWlY1jl8i+z7q2JNCbmse8VE4dtwxUO4l2lm2xc5
+P525PNDJ6FV//voySlsEmfUe8xx6r6VdSRgnts57J4L8vuXUNuv53nFEb50Gy6kkiQ9oR9
+VJ7wJMgjG+vz1ZCHhjMy6EB51IRKAuIS8mbqrHzlBKiiIwRkBgkdaKc0gbI1bmD9mLVBL8
+VBkLs2o6pApTyhtzHA5HL1DMyZC/9h5l/HL2TpL+FIMugQAAAIAOgoayy/RCt8pgdksKGc
+PwaJGRxwMzBt2dhmrWjr5WyQU91WcOILX+fgHFuEZJs77BUHXCXjIlcO1QWtKWAqRacTHG
+O6f8YQ+DpPbpxZW2iBhmazvsn8IHXasiJGF3ybLAJ1eyyFgZLp9JhRFo/qLlpCHNuEA9bZ
+S45xFyTYUalgAAAIEA8kpd/y5m1XT5xk5jSY7iZD0T4ZFcmAdL9k2K4qv2I8p/4d6SbIJW
+8NLSqCy7IS55ejwBcavN6m4RfUZNUAX7OvlEAQDzEgq8TghOHrrjeraTtpP1dl2px8UnSR
+Z+3gc8WbWLXfpdJuzzQWY2VbIkKyqM3oRUeBKoMPoleFMCTpcAAACBAMWpNt6eQ9JQe5Wa
+q4WXPSbY2GpTQ7wA36sNjQzYlK92x038cBz1BJmouR2bvRLzByX+tx7WaJHSQZWzioDfFM
+rj2GekmLcK9yypo+W/TI+aHDRhmnnv9ybmtAW0KNuJK1TYx4sbfZ0ySEgQFpJD8Wwii2Aj
+FuysqdtZSYy5FpHrAAAAFmFub25AZ2l0LmVtYWNzY29uZi5vcmcBAgME
+-----END OPENSSH PRIVATE KEY-----