(no commit message)
[wiki.git] / projects / www.mdwn
index a428fc63a71c47f28626bef891b3274d05a1609c..5b8a7771f9bda622a8c5b11f4c7fac55ab1d0267 100644 (file)
@@ -1,5 +1,5 @@
 [[!meta title="The SIPB Website"]]
-[[!toc ]]
+[[!toc]]
 
 ## Design
 
 
 ## Todo
 
-* git push (scripts-git, or gitosis on an XVM)
 * make style usable for other SIPB sites?
 * make title == alt on images
 * sipb-door widgets
 * other widgets
-* migrate sipb.mit.edu/doc
 * usability tests
-* table of contents doesn't work. Likely to do with the co-opting of h1 
-exclusively for breadcrumbs ... 
 
 ### Done
+* table of contents doesn't work. Likely to do with the co-opting of h1 
+exclusively for breadcrumbs ... 
+* migrate sipb.mit.edu/doc
+* git push (scripts-git, or gitosis on an XVM)
 * commit zephyrs for git (ikiwiki.git)
 * breadcrumbs style
 * add a grumpy fuzzball favicon to replace the ikiwiki one.
@@ -39,7 +39,7 @@ after each edit.
 
 ###For development's sake:
 
-####How Do I make edits?
+####How do I make edits?
 If you want to just edit contents, use the web interface (edit links at bottom of page) or "git clone git+ssh://sipb-www@scripts.mit.edu/mit/sipb-www/git/wiki", make your edits in the mdwn, etc.
 
 When you commit, ikiwiki should get automatically republished as HTML.
@@ -50,6 +50,16 @@ To work on the code surrounding the wiki in addition to the wikitext, clone the
     $ cd sipb-www
     $ git submodule update --init
 
+You can also clone directly from the filesystem if you have AFS permission. If you want a preview of your pages to be generated locally, you can use the generate-preview.sh script in the superrepo:
+
+    $ git clone /mit/sipb-www/git/sipb-www
+    $ cd sipb-www
+    $ git submodule update --init
+    $ # make changes here
+    $ mkdir /tmp/sipb-out
+    $ ./generate-preview.sh /tmp/sipb-out
+    $ firefox /tmp/sipb-out/index.html
+
 
 ####Detailed Locker Layout
 
@@ -77,6 +87,8 @@ To work on the code surrounding the wiki in addition to the wikitext, clone the
     |   |-- cgitrc : configuration for cgit
     |   |-- ikiwiki.setup: configuration for ikiwiki
     |   `-- src: where ikiwiki checks out wiki.git for building
+    |-- planet: Source code and templates for Planet SIPB
+    |   `-- sipb/basic: Our configuration
     |-- src
     |   \-- cgit: where cgit was built from (not actively changed)
     |-- web_scripts