参加するには?

#sphinxjpではメーリングリストへの参加=コミュニティへの参加とみなします。入会金や会費などは一切かかりません。

参加に際しては sphinx-users.jp 会則を確認して下さい。

必要なスキルは?

よく誤解される内容として「SphinxはPython(パイソン)というプログラミング言語で書かれているから、Pythonを知らないと使いこなせない」というものがあります。

Sphinxは確かにPythonで書かれていますが、Sphinxの拡張機能を作ったり、Sphinx本体のバグ修正や機能拡張をしたいと思わない限りは不要です。下記に、コミュニティで活動したい内容ごとの必要なスキルをまとめます。

ここで挙げた各種知識や能力などは一つの目安です。コミュニティでの活動を通じて、これから学ぶことも可能ですが、熱意と勇気は事前にご用意いただく必要があります。

何がしたいか?

必要なスキル

ドキュメント作成の情報交換がしたい

  • ドキュメントを書く能力と熱意

  • Sphinx(reStructuredText)を書く能力

  • 黒い画面(コマンドプロンプト)を怖がらない勇気

  • メーリングリスト等で質問・回答する勇気

  • イベントなどに参加する勇気

翻訳に関する情報交換がしてみたい。

  • Sphinx(reStructuredText)を書く能力

  • 黒い画面(コマンドプロンプト)を怖がらない勇気

  • 翻訳対象に関する知識

  • 日本語を書く能力

  • 翻訳元の言語(英語など)を読む能力

  • イベントなどに参加する勇気

  • メーリングリスト等で質問・回答する勇気

Sphinxの拡張機能が作りたい

  • Sphinxに関する知識

  • 拡張機能を作る熱意

  • Pythonでプログラミングする能力

  • 英語の資料を読む能力 1

  • 英語のドキュメントを作成する能力 2

#sphinxjpのサイトの間違いを見つけたので訂正したい

  • Github へのユーザ登録

  • #sphinxjpのIssue にチケットを投稿する勇気

  • 軽微な修正であれば、ウェブサイト上から編集アイコンを押すことでその場で修正&Pull Request送信もできます

自分のノウハウを#sphinxjpのサイトに公開したい

  • ご自分のノウハウ

  • GitHubへのユーザ登録

  • gitを使う能力

  • GitHubでforkして、Pull Requestを出す勇気 3

採用事例に自分の例も追加して欲しい

  • 採用された事例やテンプレート

  • Bitbucketへのユーザ登録

  • Mercurial(hg)を使う能力

  • Bitbucketでforkして、PullRequestを出す勇気

脚注

1

現状ではSphinxのソースや、Docutilsの英語資料を読む必要があります。

2

作ったら世界に公開しましょう!英語の確認などはメンバー間で協力することもできます。

3

詳しい説明は GitHub に書かれています。

コミュニケーション

Sphinx-Users.jpでコミュニティとして用意しているコミュニケーションチャンネルは下記の通りです。

メーリングリスト

現在は閉鎖しています。Slackに移行しました。

メーリングリストとしては Sphinx開発元のML(英語) もあります。こちらはSphinx-Users.jpの運営ではありませんが、拡張機能を開発した場合のPRなどはこちらでも行う方が良いでしょう。

Twitter

Sphinx-Users.jpの公式ハッシュタグは #sphinxjp です。このハッシュタグを付けて呟いたり、質問をすると、メンバーから回答があるかもしれません。ただし、Twitterの場合は流量が多いと流れてしまうため、質問する場合にはメーリングリストの方が確実です。

Sphinx-Users.jpの情報を呟く @sphinxjp 公式アカウントもあります。

Slack

Sphinx-users.jp コミュニティの公式チャットとしてSlackを運用しています。 Slackに参加を希望される方は、こちらから 登録をお願いします。

Q & A

スタックオーバーフローを公式の質問サイトとします。MLで聞くのはコワイという方は、 sphinx タグを付けて、こちらもご利用ください。

GitHub

GitHubはソースコード管理システム上に作られたSNSです。Sphinx-Users.jpのウェブサイトもSphinxで作成されていますが、このソースコードはすべてGitHub に載っています。ここにコミットすると、ビルドされてウェブが更新されます。

Sphinx-Users.jpのウェブサイトにドキュメントを掲載したい場合には、MLなどで表明してもらえれば、コミット権を提供することもできますし、軽微な修正であればGitHubサイト上で編集アイコンを押せば簡単に修正リクエストを送ることもできます。新規ページ追加などはSphinx-Users.jpのウェブサイトのリポジトリをフォークして、自分のリポジトリ上で編集を加えてから、Pull Requestを投げることも可能です。

Pull Requestというのは、「こういう修正したから、本家の方で取り込んでください」という依頼を投げる仕組みです。GitHubのPull Requestの仕組みを使うと、取り込み側は1ボタンで取り込むことができるというメリットがあります。現在オープンソースの開発のスタンダードとなっているワークフローです。