expo/expoweb
1
0
Fork 0
mirror of https://expo.survex.com/repositories/expoweb/.git/ synced 2024-11-28 18:21:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add info to website manual on doing read-only checkouts

Browse Source
This commit is contained in:
Wookey 2015-04-22 16:38:57 +01:00
parent a21ff2a0cc
commit 4c8685ddc1
1 changed files with 25 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
handbook/update.htm
View File

@ -7,7 +7,7 @@
<body> <body>
<h2 id="tophead">CUCC Expedition Handbook</h2> <h2 id="tophead">CUCC Expedition Handbook</h2>
<h1>Expo Website</h1> <h1>Expo Website</h1>
<p>The website is now large and complicated with a lot (too many!) of moving parts. This handbook section contains info at various levels: simple 'Howto add stuff' information for the typical expoer, more detailed info for cloning it onto your own machine for more significant edits, and structural info on how it's all put together for people who want/need to change things.</p> <p>The website is now large and complicated with a lot of (too many!) moving parts. This handbook section contains info at various levels: simple 'Howto add stuff' information for the typical expoer, more detailed info for cloning it onto your own machine for more significant edits, and structural info on how it's all put together for people who want/need to change things.</p>
<ul> <ul>
<li><a href="#update">Updating the website</a></li> <li><a href="#update">Updating the website</a></li>
@ -22,13 +22,13 @@
<p>You can update the site via the troggle pages, by editing pages online via a browser, by editing them locally on disk, or by checking out the relevant part to your computer and editing it there. Which is best depends on your knowledge and what you want to do. For simple addition of cave or survey data troggle is recommended. For other edits it's best if you can edit the files directly rather than using the 'edit this page' button, but that means you either need to be on expo with the expo computer, or be able to check out a local copy. If neither of these apply then using the 'edit this page' button is fine.</p> <p>You can update the site via the troggle pages, by editing pages online via a browser, by editing them locally on disk, or by checking out the relevant part to your computer and editing it there. Which is best depends on your knowledge and what you want to do. For simple addition of cave or survey data troggle is recommended. For other edits it's best if you can edit the files directly rather than using the 'edit this page' button, but that means you either need to be on expo with the expo computer, or be able to check out a local copy. If neither of these apply then using the 'edit this page' button is fine.</p>
<p>It's important to understand that everything on the site is stored in a distributed version control system (DVCS) called 'mercurial', which means that every edited file needs to be 'checked in' at some point. The Expo website manual goes into more detail about this, below. This stops us losing data and makes it very hard for you to screw anything up permanently, so don't worry about making changes - they can always be reverted if there is a problem. It also means that several people can work on the site on different computers at once and normally merge their changes easily.</p> <p>It's important to understand that everything on the site is stored in a distributed version control system (DVCS) (called 'mercurial'), which means that every edited file needs to be 'checked in' at some point. The Expo website manual goes into more detail about this, below. This stops us losing data and makes it very hard for you to screw anything up permanently, so don't worry about making changes - they can always be reverted if there is a problem. It also means that several people can work on the site on different computers at once and normally merge their changes easily.</p>
<p>Increasing amounts of the site are autogenerated, not just files, so you have to edit the base data, not the generated file. All autogenerated files say 'This file is autogenerated - do not edit' at the top - so check for that before wasting time on changes that will just be overwritten</p> <p>Increasing amounts of the site are autogenerated, not just files, so you have to edit the base data, not the generated file. All autogenerated files say 'This file is autogenerated - do not edit' at the top - so check for that before wasting time on changes that will just be overwritten</p>
<h2>Expo website manual</h2> <h2>Expo website manual</h2>
<p>Editing the expo website is an adventure. Until now, there was no guide which explains the whole thing as a functioning system. Learning it by trial and error is non-trivial. There are lots of things we could improve about the system, and anyone with some computer nous is very welcome to muck in. It is slowly getting better organised</p> <p>Editing the expo website is an adventure. Until now, there was no guide which explains the whole thing as a functioning system. Learning it by trial and error is non-trivial. There are lots of things we could improve about the system, and anyone with some computer nous is very welcome to muck in. It is slowly getting better organised.</p>
<p>This manual is organized in a how-to sort of style. The categories, rather than referring to specific elements of the website, refer to processes that a maintainer would want to do.</p> <p>This manual is organized in a how-to sort of style. The categories, rather than referring to specific elements of the website, refer to processes that a maintainer would want to do.</p>
@ -55,7 +55,11 @@
<h3><a id="usernamepassword">Getting a username and password</a></h3> <h3><a id="usernamepassword">Getting a username and password</a></h3>
<p>Use these credentials for access to the site. The user is 'expo', <p>Use these credentials for access to the site. The user is 'expo',
with a cavey:beery password. Ask someone if this isn't enough clue for you.</p> with a cavey:beery password. Ask someone if this isn't enough clue for you.
<b>This password is important for security</b>. The whole site <strong>will</strong get hacked by spammers or worse if you are not careful with it. Use a secure method for passing it on to others that need to know (i.e not unencrypted email), don't publish it anywhere, don't check it in to the website by accident. A lot of people use it and changing it is a pain for everyone so do take a bit of care.
</p>
<p>Note that you don't need a password to view most things, but you will need ne to change them</p>
<h3><a id="repositories">The repositories</a></h3> <h3><a id="repositories">The repositories</a></h3>
@ -87,16 +91,28 @@ stored just as files (not in version control). See below for details on that.</p
<dl> <dl>
<dt>expoweb (The Website)</dt> <dt>expoweb (The Website)</dt>
<dd><tt>hg [clone|pull|push] ssh://expo@expo.survex.com/expoweb</tt></dd> <dd>
<tt>hg [clone|pull|push] ssh://expo@expo.survex.com/expoweb</tt> (read/write)<br />
<tt>hg [clone|pull|push] http://expo.survex.com/repositories/home/expo/expoweb/</tt> (read-only checkout)
</dd>
<dt>troggle (The Website backend)</dt> <dt>troggle (The Website backend)</dt>
<dd><tt>hg [clone|pull|push] ssh://expo@expo.survex.com/troggle</tt></dd> <dd>
<tt>hg [clone|pull|push] ssh://expo@expo.survex.com/troggle</tt> (read/write)<br />
<tt>hg [clone|pull|push] http://expo.survex.com/repositories/home/expo/troggle/</tt> (read-only checkout)
</dd>
<dt>loser (The survey data)</dt> <dt>loser (The survey data)</dt>
<dd><tt>hg [clone|pull|push] ssh://expo@expo.survex.com/loser</tt></dd> <dd>
<tt>hg [clone|pull|push] ssh://expo@expo.survex.com/loser</tt> (read/write)<br />
<tt>hg [clone|pull|push] http://expo.survex.com/repositories/home/expo/loser/</tt> (read-only)
</dd>
<dt>tunneldata (The Tunnel drawings)</dt> <dt>tunneldata (The Tunnel drawings)</dt>
<dd><tt>hg [clone|pull|push] ssh://expo@expo.survex.com/tunneldata</tt></dd> <dd>
<tt>hg [clone|pull|push] ssh://expo@expo.survex.com/tunneldata</tt> (read/write)<br />
<tt>hg [clone|pull|push] http://expo.survex.com/repositories/home/expo/expoweb/</tt> (read-only)
</dd>
</dl> </dl>
<p>Photos, scans (logbooks, drawn-up cave segments) (This is about <p>Photos, scans (logbooks, drawn-up cave segments) (This is about