Welcome to reSTudy Japan’s documentation!

We are reSTrucured text Users & DeploYers in Japan.

Let’s study restructured text!

reST step by step

reST Life

About Us

reSTudy は、reSTructured Text (reST) によるドキュメントサンプルをまとめる活動をするグループです。

勉強会というより、普及のための知見集約&コンテンツを作るための調査や議論を指向してます。

活動における主なテーマとしては、下記を考えています。

  • reST / Sphinx の実践的な使い方、事例の調査・議論、コンテンツ化
  • どこを探したらreST / Sphinxの情報を得られるのかというポインタの集約
  • 関連英語ドキュメントの翻訳、および既存翻訳情報の集約
  • Sphinx 逆引き辞典 充実化への協力

これにより

  • 敷居が下がってユーザが増える。
  • 利用現場が増えて、reST & Sphinx に対する心理的な拒絶がなくなる。(Excelやめようず)

につながると嬉しいな、と。

活動指針

ディスカッション

  • Google Groups reSTudy で行なう。
  • テーマ別にスレッドを切る感じ
  • 必要に応じて、face to face で mini meeting を開催する。

meeting

  • 参加者全員がなにか疑問や成果を持ち合う場にしたい。
  • ディスカッションを元に、テーマを決めてreSTudy meetingを開催。
  • meeting の成果は可能な限りコンテンツに反映していく。

contents

  • コンテンツは reST で記述し、マスターは、BitBucket に置く。
    • コンテンツから clone したものは自由改変OK。
    • 逆に自由改変がNGなものはコンテンツには置かない。
  • Sphinx と密接に関わる部分は Sphinx-user-jp と連携する。
    • そうでない部分については適切な公開方法を適当に考える。
  • コンテンツ管理に関わる部分は、Issueにチケット登録し、できるだけ後日振り返ることができるようにする。
  • BitBucket上の権限ポリシーについては、当面下記で運営する。
    • WiKi: BitBucket にアカウントあれば誰でも利用OK。
    • IssuesBit: Bucket にアカウントあれば誰でも利用OK。
    • リポジトリ: write権限のある誰かがこの人ならOKと宣言してもらえれば権限付与

関連リソース

Indices and tables