Author: ssmiweve
Date: 2008-01-23 20:06:56 +0100 (Wed, 23 Jan 2008)
New Revision: 6022
Modified:
trunk/src/site/apt/index.apt
Log:
update documentation to new sesat layout
Modified: trunk/src/site/apt/index.apt
===================================================================
--- trunk/src/site/apt/index.apt 2008-01-23 13:30:06 UTC (rev 6021)
+++ trunk/src/site/apt/index.apt 2008-01-23 19:06:56 UTC (rev 6022)
@@ -1,38 +1,30 @@
-Sesam Search (search-main)
+* SESAT Kernel
- Umbrella project for the search kernel and all the skins.
- Contains svn:externals links to these modules.
-
- Also contains utility scripts only applicable to the project stack as a
whole.
-
-
-* SESAT (search-portal)
-
The sesam kernel consists of a number of modular
-[/maven2/SITE/schibstedsok-search/search-portal/sesat-core-api/apidocs/no/sesat/search/doc-files/SearchPortalComponents2]
components
+[sesat-core-api/apidocs/no/sesat/search/doc-files/SearchPortalComponents2]
components
providing different
{{{http://openide.netbeans.org/tutorial/api-design.html}
Application Programming Interfaces (APIs) and Service Provider Interfaces
(SPIs)}}.
All requests to the sesam cluster (any sesam search frontend) go first to
the search engine. The
-{{{search-portal/sesat-war/apidocs/no/schibstedsok/searchportal/http/filters/SiteLocatorFilter.html}
+{{{sesat-war/apidocs/no/sesat/search/http/filters/SiteLocatorFilter.html}
SiteLocatorFilter}} intercepts the request, determines the correct skin, from
the host-headers domain, loading into an
Site object, and then either, for client or server resources sends a redirect
to the corresponding skin, or forwards
the request onto one of the kernel's
-{{{search-portal/sesat-war/apidocs/no/schibstedsok/searchportal/http/servlet/package-summary.html}servlets}}.
+{{{sesat-war/apidocs/no/sesat/search/http/servlet/package-summary.html}servlets}}.
For a thousand foot view of the kernel architecture see the javadoc
package description
-{{{search-portal/sesat-core-api/apidocs/no/schibstedsok/searchportal/}no.schibstedsok.searchportal}}
+{{{sesat-core-api/apidocs/}no.ssesat.search}}
For information on setting up the project to develop read
-{{{https://dev.schibstedsok.no/confluence/display/TECHDEV/Setting+up+Sesam}Setting
up Sesam}}
+{{{http://sesat.no/development-guidelines.html}Setting up Sesam}}
- For information of operations on test and production environments and on
the code read
+ TODO needs updating: For information of operations on test and production
environments and on the code read
{{{https://dev.schibstedsok.no/confluence/display/TECHDEV/Operations+Documentation+-+Search+Portal}
Operations Documentation - Search Portal}}
-* Skins (search-config)
+* Skins (generic.sesam)
Skins come in three categories, generic, country, and sitesearch. They are
heirarchical with country and sitesearch
skins generally leaves on the heirarchy, and the generics used for
organisation benefits.
@@ -49,10 +41,10 @@
Server-side configuration files are generally inheritable through the
skin's heirarchy. The exact inheritence
implementation depends of the filetype. See
-{{{search-portal/sesat-site-spi/apidocs/no/schibstedsok/searchportal/site/config/UrlResourceLoader.html}
+{{{sesat-site-spi/apidocs/no/sesat/search/site/config/UrlResourceLoader.html}
AbstractResourceLoader}} for more details.
- For information on creating new skins, and general skin operations, read
+ TODO needs updating: For information on creating new skins, and general
skin operations, read
{{{https://dev.schibstedsok.no/confluence/display/TECHDEV/SiteSearch}SiteSearch}}
@@ -61,5 +53,5 @@
Tests are located in, and packaged from, the search-portal projects.
Some are run against the search-portal but mostly the skins depend on the
-test.jar and, via the testng.xml, declare
which of the tests to include, and run them against the skin's actual
configuration.
- This is far more useful than mocking up a dummy configuration.
+ This is currently more useful than mocking up a dummy configuration.
_______________________________________________
Kernel-commits mailing list
[email protected]
http://sesat.no/mailman/listinfo/kernel-commits
