From a9e5a7803730b55d2e6b0c87ab65667d18bf4e02 Mon Sep 17 00:00:00 2001 From: Will Rossiter Date: Sat, 12 Mar 2011 17:11:21 +1300 Subject: [PATCH] MINOR: tidied up documentation formatting and added missing statement --- docs/en/index.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/en/index.md b/docs/en/index.md index 13864ad..8ebdc12 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -18,19 +18,22 @@ you need to add the following to your applications _config.php file: DocumentationSearch::enable(); -After adding that line you will also need to build the indexes of the search. You can run the following from your webbrowser or via sake +After adding that line you will also need to build the indexes of the search. You can do this either via your web browser by accessing + http://yoursite.com/dev/tasks/RebuildLuceneDocsIndex?flush=1 +Or rebuild it via sake. You will want to set this up as a cron job if your documentation search needs to be updated on the fly + + sake dev/tasks/RebuildLuceneDocsIndex flush=1 ### Using a URL other than /dev/docs/ By default, the documentation is available in `dev/docs`. If you want it to live on the webroot instead of a subfolder, -add the following configuration to your `mysite/_config.php`: +add the following configuration to your. DocumentationViewer::set_link_base(''); Director::addRules(1, array( '$Action' => 'DocumentationViewer', '' => 'DocumentationViewer' )); - \ No newline at end of file