OSDN入門、はじめの一歩

この文書は、OSDNでソフトウェア開発を簡単に始められるようにするためのものです。この文章は完全ではありませんし、(もちろん)時間が経つにつれOSDNにもっと機能が追加されるにつれ、新しい内容も追加されることでしょう。この文章の目的は新しいプロジェクトをはじめるときの設定をステップバイステップ方式で手引きすることです。まず、新しい開発者が直面すると思われる最もありふれた状況を概説しましょう。あなたは既にソースコードのディレクトリを保持していて、現行のコードリポジトリがあるかも知れませんし、新しいオープンソースのプロジェクトを興すためにOSDNのすべての機能を使いたいと思っているかもしれません。また、新しい開発者と多くの利用者も引き付けたいという希望を抱いているかもしれません。さてそれでははじめましょう。

新しいプロジェクトをはじめるためのステップ

以下は簡単な流れです。詳細はこのあとに続きます

  1. OSDNに新規ユーザーとして登録する
  2. 作成したユーザーでログインして新しいプロジェクトを作成するか、あるいは個人の作業部屋(PersonalForge)を作成する
  3. グループ、プロジェクトや作業部屋の情報を設定する
  4. ソースコードの最新スナップショットのコードリポジトリを作成する
  5. プロジェクトであれば、グループのWebサイトを設定する
  6. 開発のためにSCMツールに慣れ、仕事を始める
  7. みんなにわかるようにファイルモジュールをリリース

そしていくつか他にもする必要があるかもしれない……

さて、お仕事に取り掛かりましょう。

1. OSDNに新規ユーザーとして登録する

すでにOSDNにアカウントを持っている場合は、もちろんこのステップを飛ばしていただいて構いません。

OSDN トップページなどで、右上に表示されているメニューから アカウント作成をクリックしてください。そこで、個人情報(名前とメールアドレス、いくつかの設定)を登録することによって、あなたのユーザーアカウントが設定されます。OSDNで情報のやり取りなどを含む活動をするにはユーザーアカウントが必要となります。これは1回手続きしてしまえば、「ログイン」をたどることでこのユーザーとしていつでもログインできます。

ログインすると自分のマイページ(ホームページ)が表示されます。そこには参加しているプロジェクトや個人の作業部屋がリストされ、それに関する情報も表示されます。自分のマイページには、上部に表示されているOSDNのタイトルロゴやホームアイコンから、いつでもアクセスできます。マイページ上部のメニューバーから項目を選択することで、自分の公開情報や活動の履歴/活動統計などを参照することができます。また、このメニューの一番右にある「ユーザ設定」から自分のアカウントの各種設定を変更できます(ユーザ設定は、ページ最上部にもリンクがあります)。

2. 作成したユーザーでログインし、新しいプロジェクトまたは個人作業部屋を作成する

プロジェクトおよび個人用の作業部屋の作成は、自身のホームページあるいは上部の「開発」メニューから行うことができます。

ホームページあるいは「開発」ページには、「プロジェクト作成」および「作業部屋の作成」といったボタンがありますので、それを押しましょう。 この手続きは始めから終りまで簡単に進めることができることでしょう。すべての必要とする情報はそこに書かれています。

個人作業部屋に関しては、情報を入力後ただちに作業部屋が作成されます。プロジェクトに関しては、情報入力の完了後にOSDN運営スタッフにその内容が送られ、スタッフはそれがOSDNの目的にかなうかどうか検討し、問題がなければ数時間内にプロジェクトが作成されます。オープンソースなのであれば、すぐに許可されることでしょう。

最長でも24時間以内には、新規プロジェクトの作成に関する返事がをあると思います(それまでまって何もアクションがない場合はメールで確認してみてくださいい)。

申請が受理されるとプロジェクトが作成され、あなたがプロジェクト管理者として登録されます。登録されたプロジェクトは、自分のマイページから確認することができます。

3. あなたのプロジェクトの情報を設定する

プロジェクトページへのリンクを押しましょう! そうするとあなたのプロジェクトの開発ダッシュボードのページが開きます。

まずは各プロジェクトのメニューの一番右にある「管理」を開き「管理サマリ」を開きましょう。 ここからはプロジェクトの現在の情報を確認できます。そのページの上部には、プロジェクトの開始時に設定を行なっておくといい(設定をしておかなければならない)項目が順番に説明されています(設定ページにリンクがはられています)。そのリンクから順に設定を行なっておくといいでしょう。

プロジェクト自体の設定は、すべてこの「管理」のメニューから行えます。また、個々のプロジェクトの機能を有効にすると(ディフォルトでいくつかの機能は有効にされています)、各機能のメニューが同じように表示されます。各機能それぞれの設定は、このメニューの下部にある「管理」から行うこともできます。

4. コードを取り込む

プロジェクトのコードをソースコード管理システムに取り込みましょう。OSDNではGitあるいはSubversionの利用を推奨しています(他には、Mercurial(Hg)/Bazzer が利用可能です)。

5. グループのウェブサイトを設定する。

プロジェクトのメンバーは、何らかの情報を提供するためのウェブページまたはすでに構築されたサイトをOSDN上にホスティングしたいと考えているかと思います。SSHを使ってOSDNにログインしてください。たとえば、

ssh -l ログイン名 shell.osdn.net

いまあなたのホームディレクトリにいることでしょう。これからはすべてのグループファイルは /home/groups/x/xx/YourProjectに保管されます。そのディレクトリに移動してください。すべてのウェブページはhtdocsディレクトリに保管します。ログアウトし、sshについてたプログラムのscpを使ってあなたのウェブページのファイルをコピーします。たとえば、

scp File ログイン名@shell.osdn.net:/home/groups/x/xx/YourProject/htdocs

サイトをgzipすることをお勧めします。scpを使って一発で送ります。それからsshでログインし、それをgunzipします。

さてウェブページには何を載せればよいのでしょうか?たぶんあなたのプロジェクトの情報として以下のものでしょう。

  • OSDNのプロジェクトページへのリンク。
  • メーリングリストへのリンク(これからすぐ後に作ります)
  • OSDNのアイコンとウェブカウンタ。このことについてはサイトドキュメントを見てください。

初期状態として、こういった情報がのった html ファイルのサンプルをプロジェクトのhtdocsディレクトリ 以下に用意してあります。このファイルを元に修正を行う場合は、直接編集できないパーミッションに なっていますので、コピーしてお使いください。