You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by gn...@apache.org on 2011/02/11 18:38:37 UTC
svn commit: r1069904 - in /karaf/site/trunk: ./
src/main/webapp/index/community/ src/main/webapp/index/community/faq/
Author: gnodet
Date: Fri Feb 11 17:38:37 2011
New Revision: 1069904
URL: http://svn.apache.org/viewvc?rev=1069904&view=rev
Log:
Update documentation about the web site itself
Modified:
karaf/site/trunk/pom.xml
karaf/site/trunk/src/main/webapp/index/community/faq.page
karaf/site/trunk/src/main/webapp/index/community/faq/how-do-i-edit-the-website.page
karaf/site/trunk/src/main/webapp/index/community/faq/how-do-i-restart-from-a-clean-state.page
karaf/site/trunk/src/main/webapp/index/community/faq/how-does-the-website-work.page
Modified: karaf/site/trunk/pom.xml
URL: http://svn.apache.org/viewvc/karaf/site/trunk/pom.xml?rev=1069904&r1=1069903&r2=1069904&view=diff
==============================================================================
--- karaf/site/trunk/pom.xml (original)
+++ karaf/site/trunk/pom.xml Fri Feb 11 17:38:37 2011
@@ -109,6 +109,16 @@
<artifactId>slf4j-api</artifactId>
<version>1.6.0</version>
</dependency>
+ <dependency>
+ <groupId>org.scala-lang</groupId>
+ <artifactId>scala-library</artifactId>
+ <version>2.8.1</version>
+ </dependency>
+ <dependency>
+ <groupId>org.scala-lang</groupId>
+ <artifactId>scala-compiler</artifactId>
+ <version>2.8.1</version>
+ </dependency>
</dependencies>
<build>
Modified: karaf/site/trunk/src/main/webapp/index/community/faq.page
URL: http://svn.apache.org/viewvc/karaf/site/trunk/src/main/webapp/index/community/faq.page?rev=1069904&r1=1069903&r2=1069904&view=diff
==============================================================================
--- karaf/site/trunk/src/main/webapp/index/community/faq.page (original)
+++ karaf/site/trunk/src/main/webapp/index/community/faq.page Fri Feb 11 17:38:37 2011
@@ -1,15 +1,13 @@
----
-title: FAQ
-page_version: 4
-page_creator: gnodet
-page_modifier: gnodet
---- pipeline:conf
+---
+title: FAQ
+page_version: 4
+page_creator: gnodet
+page_modifier: gnodet
+--- pipeline:conf
h2. FAQ
Here are a list of commonly asked questions and answers. If you have any questions which are not on this list, please talk to us on the [Forums|Discussion Forums].
-We [welcome contributions|Contributing] and this entire website is a [wiki that you can edit|How does the website work] so please join in and help us make the documentation better!
-
h3. General Questions
* [How Do I Become A Committer]
Modified: karaf/site/trunk/src/main/webapp/index/community/faq/how-do-i-edit-the-website.page
URL: http://svn.apache.org/viewvc/karaf/site/trunk/src/main/webapp/index/community/faq/how-do-i-edit-the-website.page?rev=1069904&r1=1069903&r2=1069904&view=diff
==============================================================================
--- karaf/site/trunk/src/main/webapp/index/community/faq/how-do-i-edit-the-website.page (original)
+++ karaf/site/trunk/src/main/webapp/index/community/faq/how-do-i-edit-the-website.page Fri Feb 11 17:38:37 2011
@@ -1,35 +1,63 @@
----
-title: How do I edit the website
-page_version: 1
-page_creator: gnodet
-page_modifier: gnodet
---- pipeline:conf
+---
+title: How do I edit the website
+page_version: 1
+page_creator: gnodet
+page_modifier: gnodet
+--- pipeline:conf
h2. How do I edit the website?
-The website is all contained on a Wiki so that you can [contribute|Contributing] providing you are happy to license all your contributions under the [Apache Software License version 2.0|http://www.apache.org/licenses/LICENSE-2.0]
+h3. Organization
-h3. You must have signed an ICLA to be able to edit the wiki pages
-* Download and print the Apache Contributor License Agreement from [here|http://www.apache.org/dev/new-committers-guide.html]. You need to sign it, scan it and email it
-* wait for your name to appear on the [list of received CLAs|http://people.apache.org/committer-index.html] see the _unlisted CLAs_ section.
-* send an email to the [Karaf dev forum|Mailing Lists] about that your ICLA have been received at Apache.
+The web site consists of three main resources:
+* the main web site available at [http://karaf.apache.org/]
+* the manuals available at [http://karaf.apache.org/manual/]
+* the wiki available at [http://cwiki.apache.org/KARAF/]
+
+h3. Main site
+
+The main website sources are located in svn at [{{https://svn.apache.org/repos/asf/karaf/site/trunk}}]. This source tree is a maven project that uses [Scalate|http://scalate.fusesource.org] as a templating engine.
+The easiest way to make some modifications to it is to run the following command:
+{code}
+mvn jetty:run -Plive
+{code}
+This will start up a jetty server and you'll be able to see the live rendering of the web site at
+{code}
+http://localhost:8080/
+{code}
+
+You can now make modifications to the source tree and reload the web page in your browser. Changes will be picked up immediately.
+
+The {{-Plive}} parameter allows updating without restarting the web server, but in some cases, there may be a few problems, so a final check can be done by running
+{code}
+mvn install
+{code}
-h3. How to edit
+and checking the resulting site in {{target/sitegen}}.
-To edit a page, just hit the *edit* link right at the bottom of any page. To be able to edit you need to register with confluence.
+If you don't have committer access, create a JIRA and attach the {{svn diff}} output to it so that we can apply it.
+If you are a committer, just commit your changes.
-{info:title=Spam Prevention}
-We have been attacked by spammers so we are running a spam-avoiding scheme. So you have to ask to be added to the editing group of Confluence. This is quick and easy to do.
+To deploy your modifications, you need to run the following command:
+{code}
+mvn scalate:deploy
+{code}
-First click edit on a page to get to the confluence site of http://cwiki.apache.org/confluence/display/KARAF/Index then register.
-Then send an mail to the [developer forum|http://www.nabble.com/xxx.html] giving details of your confluence and/or JIRA username and we can grant you the necessary editing karma.
-{info}
+h3. Manuals
-Note that after you've changed the wiki it is immediately rendered on the http://cwiki.apache.org/KARAF/ site so you can test it out; then up to an hour or two later it is updated on the Apache site.
+After a release, the corresponding manual should be uploaded and the [documentation] updated.
+Uploading the manual can be done by checking out the associated tag and running {{mvn scalate:deploy}} inside the {{manual}} svn director.
+
+h3. Wiki
+
+The wiki contains the 2.1.x manual and any collaboration documents, such as the roadmaps, etc...
+
+You must have signed an ICLA to be able to edit the wiki pages
+* Download and print the Apache Contributor License Agreement from [here|http://www.apache.org/dev/new-committers-guide.html]. You need to sign it, scan it and email it
+* wait for your name to appear on the [list of received CLAs|http://people.apache.org/committer-index.html] see the _unlisted CLAs_ section.
+* send an email to the [Karaf dev forum|Mailing Lists] about that your ICLA have been received at Apache.
-h3. How the site works
-There are a few special pages; for example the [Navigation] page is the left hand navigation bar and the [QuickLinks] is the top right navigation bar.
+To edit a page, just hit the *edit* link right at the bottom of any page. To be able to edit you need to register with confluence.
-Other useful [links|Site] are
+Note that after you've changed the wiki it is immediately rendered on the {{http://cwiki.apache.org/KARAF/}} site so you can test it out; then up to an hour or two later it is updated on the Apache site.
-{include:Site}
Modified: karaf/site/trunk/src/main/webapp/index/community/faq/how-do-i-restart-from-a-clean-state.page
URL: http://svn.apache.org/viewvc/karaf/site/trunk/src/main/webapp/index/community/faq/how-do-i-restart-from-a-clean-state.page?rev=1069904&r1=1069903&r2=1069904&view=diff
==============================================================================
--- karaf/site/trunk/src/main/webapp/index/community/faq/how-do-i-restart-from-a-clean-state.page (original)
+++ karaf/site/trunk/src/main/webapp/index/community/faq/how-do-i-restart-from-a-clean-state.page Fri Feb 11 17:38:37 2011
@@ -4,7 +4,9 @@ page_version: 1
page_creator: gnodet
page_modifier: gnodet
--- pipeline:conf
-h2. How do I restart from a clean state?
-
-Restarting Karaf from a clean state is very easy as Karaf stores all its working files in the {{data}} directory.
-Removing this directory and starting Karaf should bring you in the original state.
\ No newline at end of file
+h2. How do I restart from a clean state?
+
+Restarting Karaf from a clean state is very easy as Karaf stores all its working files in the {{data}} directory.
+Removing this directory and starting Karaf should bring you in the original state.
+
+You can also pass the {{clean}} argument on the command line to have it delete the {{data}} directory before starting.
\ No newline at end of file
Modified: karaf/site/trunk/src/main/webapp/index/community/faq/how-does-the-website-work.page
URL: http://svn.apache.org/viewvc/karaf/site/trunk/src/main/webapp/index/community/faq/how-does-the-website-work.page?rev=1069904&r1=1069903&r2=1069904&view=diff
==============================================================================
--- karaf/site/trunk/src/main/webapp/index/community/faq/how-does-the-website-work.page (original)
+++ karaf/site/trunk/src/main/webapp/index/community/faq/how-does-the-website-work.page Fri Feb 11 17:38:37 2011
@@ -1,18 +1,12 @@
----
-title: How does the website work
-page_version: 1
-page_creator: gnodet
-page_modifier: gnodet
---- pipeline:conf
+---
+title: How does the website work
+page_version: 1
+page_creator: gnodet
+page_modifier: gnodet
+--- pipeline:conf
h2. How does the website work
-This website is actually rendered from the Wiki contents that you can [edit|How do I edit the website].
-When viewing a page on the static HTML website you can click on the *edit* link (bottom of the page) and you can edit the page.
+This website is actually rendered offline and uploaded by a committer after it has changed.
For more information see [How do I edit the website].
-Other useful [Site links|Site] are
-
-{include:Site}
-
-Note that it takes a little while to update the Apache site at http://karaf.apache.org/ due to caching. Though this site usually updates quickly: http://cwiki.apache.org/KARAF/
\ No newline at end of file