Nguyen Tien Si

Cài đặt API Documentation System

1. Môi trường cài đặt

• Web server: Apache, IIS,...
• Cơ sở dữ liệu: MySQL, PostgreSQL.
• Scripting Language: PHP

Môi trường cài thử

• Apache/2.2.15
• MySQL 5.0.51a
• PHP 5.2.13

2. Phiên bản Drupal và module hỗ trợ

• Drupal 6.17 - http://ftp.drupal.org/files/projects/drupal-6.17.tar.gz
• Module API - http://ftp.drupal.org/files/projects/api-6.x-1.2.tar.gz
• Module Job queue - http://ftp.drupal.org/files/projects/job_queue-6.x-3.1.tar.gz

Cài Drupal xong cài tiếp 2 module trên

3. Download source

• Download source code phiên bản Drupal 5,6,7 về và lưu trong thư mục /path/to/your/code/repos/ ví dụ: /var/www/api/repos

• Với các phiên bản 5,6,7 sẽ có dạng như sau:

  • /var/www/api/repos/drupal-5
  • /var/www/api/repos/drupal-6
  • /var/www/api/repos/drupal-7

Cách làm như sau:

Đối với Drupal 5

• Vào thư mục /var/www/api/repos
  cd /var/www/api/repos
• Lấy source code Drupal 5 từ server CVS
  cvs -z6 -d:pserver:anonymous:anonymous@cvs.drupal.org:/cvs/drupal co -r DRUPAL-5 -d drupal-5 drupal
• Vào thư mục drupal-5
  cd /var/www/api/repos/drupal-5
• Lấy nội dung cấu trúc trang api documentation
  cvs -z6 -d:pserver:anonymous:anonymous@cvs.drupal.org:/cvs/drupal-contrib checkout -r DRUPAL-5 -d developer-docs contributions/docs/developer

Đối với Drupal 6

• Vào thư mục /var/www/api/repos với thư mục /var/www/api là thư mục cài Drupal
  cd /var/www/api/repos
• Lấy source code Drupal 6 từ server CVS
  cvs -z6 -d:pserver:anonymous:anonymous@cvs.drupal.org:/cvs/drupal co -r DRUPAL-6 -d drupal-6 drupal
• Vào thư mục drupal-6
  cd /var/www/api/repos/drupal-6
• Lấy nội dung cấu trúc trang api documentation
  cvs -z6 -d:pserver:anonymous:anonymous@cvs.drupal.org:/cvs/drupal-contrib checkout -r DRUPAL-6--1 -d developer-docs contributions/docs/developer
• Lấy nội dung module examples, nhưng nhớ vào thư mục developer-docs trước
  cvs -z6 -d:pserver:anonymous:anonymous@cvs.drupal.org:/cvs/drupal-contrib checkout -r DRUPAL-6--1 -d examples contributions/modules/examples

Đối với Drupal 7

• Vào thư mục /var/www/api/repos
  cd /var/www/api/repos
• Lấy source code Drupal 7 từ server CVS
  cvs -z6 -d:pserver:anonymous:anonymous@cvs.drupal.org:/cvs/drupal co -r HEAD -d drupal-7 drupal
• Vào thư mục drupal-7
  cd /var/www/api/repos/drupal-7
• Lấy nội dung cấu trúc trang api documentation
  cvs -z6 -d:pserver:anonymous:anonymous@cvs.drupal.org:/cvs/drupal-contrib checkout -r HEAD -d developer-docs contributions/docs/developer
• Lấy nội dung module examples, nhưng nhớ vào thư mục developer-docs trước
  cvs -z6 -d:pserver:anonymous:anonymous@cvs.drupal.org:/cvs/drupal-contrib checkout -r HEAD -d examples contributions/modules/examples
  

4. Cấu hình

• Vào http://api.nguyentiensi.com/admin/settings/api
• Chọn new branch http://api.nguyentiensi.com/admin/settings/api/branches/new

Thông số:

Drupal 5

• URL label: drupal-5
• Page label: Drupal 5
• Directories: /var/www/api/repos/drupal-5

Drupal 6

• URL label: drupal-6
• Page label: Drupal 6
• Directories: /var/www/api/repos/drupal-6

Drupal 7

• URL label: drupal-7
• Page label: Drupal 7
• Directories: /var/www/api/repos/drupal-7

Xong vào admin chạy cron job để index

Kết quả: http://api.nguyentiensi.com/

Chú ý:

Đối với những TAG là HEAD chỉ là tạm thời trong thời gian này, sau này Drupal 8 xuất hiện và Drupal 7 stable thì đổi lại tag tương ứng với D7, ví dụ là: DRUPAL-7--1,... Tùy cách đặt tag của Drupal.