Meego Wiki
Views

Application developer site/Documentation/Features/meego doc

From MeeGo wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
-
{{delete|I assume that you meant to propose this to be deleted when moving this into "trash".}}
+
h1. Meego doc
-
== Introduction ==
+
MeeGo docs module takes care of importing and holding the API reference pages. It contains a simple drush command which takes one argument (path to table of contents xml [toc]).
-
=== Design Overview ===
+
-
=== Team and developers ===
+
-
Current team:
+
h2. Settings
-
* Teemu Lukkari (production manager)
+
-
* Graham Honeywill (account manager)
+
-
* Quang Pham (drupal developer)
+
-
* Mika Matikainen (concept designer, graphic designer)
+
-
* Ronan MacLaverty (product owner from Nokia)
+
-
* Michael R. Shaverty (Drupal developer and hosting provider from Intel)
+
-
Other persons involved before:
+
To administer MeeGo docs, from admin menu go to *@Content management > API Reference settings@* .
-
* Mikael Kundert (drupal developer)
+
-
* Andrew Burcin (drupal developer)
+
-
* Jakub Suchy (drupal developer, API docs)
+
-
=== Project managing tools ===
+
-
Project was initially managed in Redmine hosted by Activeark. Redmine's issue tracking was replaced with MeeGo's Bugzilla at http://bugs.meego.com. In Bugzilla, site bugs are categorized under product "developer.meego.com".
+
-
Drupal source is managed by using GIT. *Source code is public and should be available at Gitorious*. See link for the repository: http://meego.gitorious.org/meego-web-infrastructure/meego-developer-website
+
h3. Default page
-
=== Environment overview ===
+
When user types path "developer.meego.com/api" Drupal should redirect user to default page. Usually this page is *main.html* .
-
Michael R. Shaver from Intel is responsible for hosting. There is plans to move hosting at Oregon State University (OSU), the status can be followed in bug #12683.
+
h3. Data path
-
'''Production and staging environment'''
+
Data path contains the HTML files having all the contents which is referred from table of contents XML (toc.xml). Example value "sites/default/files/apidocs/html"
-
Production and staging environment are in the same server. No passwords are used, instead we are using SSH public keys which should be provided to Michael when server access is needed.
+
h3. Attribute name for title
-
Production site is mapped to document root " /home/developer.meego.com/www/developer.meego.com " and uses " dev_meego " database/name. Folder is linked to repository and should contain latest stable snapshot of site.
+
Some TOC XML file may have different attribute name for title. This settings allows you to define which attribute name to look for the title. Example value "title".
-
Staging site is mapped to document root " /home/developer.meego.com/www/dev.developer.meego.com " and uses " dev_dev_mego " database/name. Folder is linked to repository and has latest state of the site.
+
h3. Attribute name for URL
-
'''Development environment'''
+
Some TOC XML file may have different attribute name for URL path to HTML files / contents. This settings allows you to define which attribute name to look for. Example value "href".
-
No centralized development environment provided. Development happens locally.
+
h2. Example usage
-
== Design Overview ==
+
<pre>drush meego-rescan sites/default/files/apidocs/xml/categories/toc.xml
-
Intel is currently responsible of hosting. The contact person for hosting is *Michael R. Shaver* from Intel.
+
Clearing menu items...
-
 
+
Processed file sites/default/files/apidocs/html/main.html
-
* Server works in operating system Nginx
+
Processed file sites/default/files/apidocs/html/categories/Application_Frameworks.html
-
* Firewall settings are unknown
+
Processed file sites/default/files/apidocs/html/qt4/qtdeclarative.html
-
* There is no load balancing currently (might possible to need one)
+
Processed file sites/default/files/apidocs/html/qt4/plugins.html
-
* Apache2 is used as HTTP server
+
Processed file sites/default/files/apidocs/html/qt4/qdeclarativeextensionplugin.html
-
* No alternative caching configured
+
Processed file sites/default/files/apidocs/html/qt4/qdeclarativecomponent.html
-
* MySQL 5.1.41 database
+
Processed file sites/default/files/apidocs/html/qt4/qdeclarativecontext.html
-
* PHP 5.2.13
+
...</pre>
-
 
+
-
=== Database architecture ===
+
-
 
+
-
Site uses Drupal's default structure, collation, storage engine.
+
-
 
+
-
Staging site is not using shared tables.
+
-
 
+
-
Production site is using following database settings:
+
-
<pre>$db_prefix = array(
+
-
  'default'  => '',
+
-
  'users'    => 'meego.',
+
-
  'authmap'  => 'meego.',
+
-
  'openid_associations' => 'meego.',
+
-
  'profile_fields'  => 'meego.',
+
-
  'profile_values'  => 'meego.',
+
-
);</pre>
+
-
 
+
-
'Note!' When synchronizing content from production site, you will be required to set node.uid to value 1 and clear cache to ensure availability of content. Nodes doesn't get loaded when user is not available (uids are different in production since we're sharing users table!).
+
-
 
+
-
== System architectural design ==
+
-
 
+
-
== Detail description of modules (patching / update) ==
+
-
 
+
-
== Detail description of content structure ==
+
-
 
+
-
== Backup solution ==
+
-
 
+
-
== Additional Materials ==
+

Revision as of 11:56, 29 March 2011

h1. Meego doc

MeeGo docs module takes care of importing and holding the API reference pages. It contains a simple drush command which takes one argument (path to table of contents xml [toc]).

h2. Settings

To administer MeeGo docs, from admin menu go to *@Content management > API Reference settings@* .

h3. Default page

When user types path "developer.meego.com/api" Drupal should redirect user to default page. Usually this page is *main.html* .

h3. Data path

Data path contains the HTML files having all the contents which is referred from table of contents XML (toc.xml). Example value "sites/default/files/apidocs/html"

h3. Attribute name for title

Some TOC XML file may have different attribute name for title. This settings allows you to define which attribute name to look for the title. Example value "title".

h3. Attribute name for URL

Some TOC XML file may have different attribute name for URL path to HTML files / contents. This settings allows you to define which attribute name to look for. Example value "href".

h2. Example usage 

drush meego-rescan sites/default/files/apidocs/xml/categories/toc.xml

Clearing menu items...
Processed file sites/default/files/apidocs/html/main.html
Processed file sites/default/files/apidocs/html/categories/Application_Frameworks.html
Processed file sites/default/files/apidocs/html/qt4/qtdeclarative.html
Processed file sites/default/files/apidocs/html/qt4/plugins.html
Processed file sites/default/files/apidocs/html/qt4/qdeclarativeextensionplugin.html
Processed file sites/default/files/apidocs/html/qt4/qdeclarativecomponent.html
Processed file sites/default/files/apidocs/html/qt4/qdeclarativecontext.html
...
Retrieved from "http://wiki.meego.com/Application_developer_site/Documentation/Features/meego_doc"
Personal tools