Initial creation of page about editing this site
authorjustin <justin@web>
Sat, 26 Sep 2009 22:57:28 +0000 (15:57 -0700)
committerCharlie <root@leaf.dragonflybsd.org>
Sat, 26 Sep 2009 22:57:28 +0000 (15:57 -0700)
docs/howtos/how_to_edit_this_site/index.mdwn [new file with mode: 0644]

diff --git a/docs/howtos/how_to_edit_this_site/index.mdwn b/docs/howtos/how_to_edit_this_site/index.mdwn
new file mode 100644 (file)
index 0000000..9f7ad83
--- /dev/null
@@ -0,0 +1,23 @@
+## Making changes
+
+* All files can be edited by anyone.  Start with the the `/sandbox` page.
+* Changes to the site config are generated into the site with the command `ikiwiki --setup /usr/local/etc/ikiwiki.setup`.
+* To create new pages on the web, add a new wiki link and then follow the link.  If you cannot find a good place for the link, use the [[/sandbox]].
+* To move a page, create a new page with the old page's content, and place '\[\[!meta redir=newpage\]\]' on the old page for a redirect.
+* To delete a page, edit it and press the "Remove" button.
+* This entire site is kept in a git repo, so larger changes/reversions can be done at the repo level.
+
+## Styles
+
+* When naming a page, use underscores to indicate spaces between words in the name.
+* Avoid CamelCase.
+* When creating a new page, make sure to link to it somewhere else on the site.
+* Use [Markdown](http://daringfireball.net/projects/markdown/syntax) for page syntax.
+* Straight HTML can be used for page element if needed, though it can get messy; stick to Markdown where possible.
+
+## For more information
+
+* This site contains ikiwiki documentation under /[[ikiwiki]].
+* Markdown is documented at [daringfireball.net](http://daringfireball.net/projects/markdown/syntax).
+* [[Formatting information|ikiwiki/formatting]] is linked at the bottom of the form when editing any page.
+* ikiwiki is documented at the [ikiwiki site](http://ikiwiki.info/).