Author: isabel
Date: Sun Dec 29 20:52:37 2013
New Revision: 1554065
URL: http://svn.apache.org/r1554065
Log:
Make wiki editing help clearer
Modified:
mahout/site/mahout_cms/trunk/content/developers/how-to-update-the-website.mdtext
Modified:
mahout/site/mahout_cms/trunk/content/developers/how-to-update-the-website.mdtext
URL:
http://svn.apache.org/viewvc/mahout/site/mahout_cms/trunk/content/developers/how-to-update-the-website.mdtext?rev=1554065&r1=1554064&r2=1554065&view=diff
==============================================================================
---
mahout/site/mahout_cms/trunk/content/developers/how-to-update-the-website.mdtext
(original)
+++
mahout/site/mahout_cms/trunk/content/developers/how-to-update-the-website.mdtext
Sun Dec 29 20:52:37 2013
@@ -1,6 +1,5 @@
Title: How To Update The Website
-
# How to update the Mahout Wiki and Website
<a name="HowToUpdateTheWebsite-Howtoupdatethemahouthomepage"></a>
@@ -13,12 +12,16 @@ Title: How To Update The Website
1. The site will automatically be exported from svn as soon as its committed
<a name="HowToUpdateTheWebsite-SomeDo'sandDont'sofupdatingthewiki"></a>
-## Some Do's and Dont's of updating the wiki
-1. Keep the wiki cleanly formatted. Assume the title is of size h1
-1. Try to keep a single page for a topic instead of starting multiple one.
+## Some Do's and Dont's of updating the web site and wiki
+1. Keep all pages cleanly formatted - this includes using standard formatting
for headers etc.
+1. Try to keep a single page for a topic instead of starting multiple ones.
If the topics are related, put it under as a child under the similar page.
1. Notify the developers of orphaned or broken links.
-1. Use the page title to link pages so that they get correctly updated by
+
+
+## Additional hints for editing the wiki pages
+
+1. When linking wiki pages inside of Confluence make sure to use the page
title to link pages so that they get correctly updated by
when someone changes the title
eg:
@@ -29,9 +32,6 @@ when someone changes the title
[Name of the link|http://<path to>/how to update the website.html]
-To update the pages, update the wiki directly. Do not change the title of
-top level pages without updating the same on the landing page.
-
Note to non-committers: If you fail to edit the wiki pages send us a brief
note on the
mailing list - there have been lots of spamming attempts which forced us to
shut down
anonymous wiki editing.
\ No newline at end of file
