Skip to content

About

GakuNin RDM developer guide

Resources

Stars

3 stars

Watchers

8 watching

Forks

Repository files navigation

RDM-developer-guide — GakuNin RDM Developer Environment 2027 / 開発環境 2027 版

Summary: Developer guide for the GakuNin RDM 2027 environment, including specifications, decisions, policies, guides, and status 概要: GakuNin RDM 2027 開発環境の開発者ガイド。仕様、決定、方針、ガイド、進捗を含みます

Jump: English · 日本語

  • Version / 版: 0.3 — 2026-11-10. Learned: a decision index goes stale one record at a time, so each new ADR is added to the root list in the same commit (ADR-08). / 決定の索引は一件ずつ古くなるので、新しい ADR は同じコミットでルートの一覧に加える(ADR-08)。
  • Version / 版: 0.2 — 2026-11-06. Learned: a glossary term is only explained for the reader when its note and REF-01 link sit at the first prose use, counting lower-case and plural forms, so first-use notes with links were added in both halves (SPEC-06 §3). / 用語注と REF-01 へのリンクは、小文字や複数形も含めた本文の初出に置かなければ読者に届かないと分かったため、英和両方の初出にリンク付きの用語注を補った(SPEC-06 §3)。
  • Version / 版: 0.1 — 2026-11-05
  • Normative for: README.md
  • Related: SPEC-06 Documentation Conventions · POL-01 Position

English

→ 日本語版へ

🚀 Quick start

Available from milestone M2.

  1. git clone https://github.com/.../RDM-developer-guide.git
  2. ./installer/install.sh --yes
  3. Open http://127.0.0.1:5000 in your browser

🧭 Map

graph TD
    subgraph docs[docs/]
        spec[specs/] 
        decisions[decisions/]
        policy[policy/]
        reference[reference/]
        guides[guides/]
        status[status/]
    end
    
    subgraph manifest[manifest/]
        upstreams[upstreams.*]
    end
    
    subgraph installer[installer/]
        install[install.sh]
        grdm_dev[grdm_dev/]
    end
    
    subgraph site[site/]
        index[index.html]
    end
    
    docs --> manifest
    docs --> installer
    docs --> site
Loading

📚 Documents

Specifications / 仕様

Policies & Decisions / 方針と決定

Each record explains one choice. Repository (a folder that remembers every change; see REF-01) placement comes first, then the network model, the staged security gate, the autonomy of AI agents, and the test IdP (the server where you log in; see REF-01) that stands in for a Shibboleth (the software that lets you log in once with your university account; see REF-01) login.

References / 参考資料

Guides / ガイド

  • Guides index - Guides for addon development and environment setup / アドオン開発と環境セットアップのガイド

Status / 進捗状況

  • Status - Project status and milestones / プロジェクト進捗とマイルストーン

🛡️ Security

This public repository contains only documentation, manifest, and installer code. Integration code is in the private RDM--dev2027 repository. A staged security gate is applied before code reaches production (see SPEC-03 Security Gate).

🌐 HTML version

The human-readable HTML version lives at site/index.html (entry page: index.html). It is generated from docs/ by MkDocs (a tool that turns Markdown files into a website; see REF-01) through grdm-dev docs build (see SPEC-02); do not edit site/ by hand.

License

MIT License — See LICENSE for details.


日本語

→ To English

🚀 クイックスタート

M2 マイルストーンから利用可能。

  1. git clone https://github.com/.../RDM-developer-guide.git
  2. ./installer/install.sh --yes
  3. ブラウザで http://127.0.0.1:5000 を開く

🧭 地図

graph TD
    subgraph docs[docs/]
        spec[specs/] 
        decisions[decisions/]
        policy[policy/]
        reference[reference/]
        guides[guides/]
        status[status/]
    end
    
    subgraph manifest[manifest/]
        upstreams[upstreams.*]
    end
    
    subgraph installer[installer/]
        install[install.sh]
        grdm_dev[grdm_dev/]
    end
    
    subgraph site[site/]
        index[index.html]
    end
    
    docs --> manifest
    docs --> installer
    docs --> site
Loading

📚 文書

仕様

方針と決定

各記録は一つの選択を説明します。まずリポジトリ(変更を全部覚えているフォルダ。REF-01)の置き場、次にネットワークモデル、段階的なセキュリティゲート、AI エージェントの自律性、そして Shibboleth(大学のアカウントで一度ログインすれば済むようにするソフト。REF-01)ログインの代わりを務めるテスト IdP(ログインする場所のサーバ。REF-01)です。

参考資料

ガイド

  • ガイド一覧 - Guides for addon development and environment setup / アドオン開発と環境セットアップのガイド

進捗状況

  • 進捗 - Project status and milestones / プロジェクト進捗とマイルストーン

🛡️ セキュリティ

このパブリックリポジトリにはドキュメント、マニフェスト、インストーラーコードのみが含まれます。統合コードは非公開の RDM--dev2027 リポジトリにあります。本番環境にコードが到達する前に段階的なセキュリティゲートが適用されます(SPEC-03 セキュリティゲート 参照)。

🌐 HTML バージョン

人が読む HTML 版は site/index.html(入口ページは index.html)にあります。docs/ から MkDocs(Markdown のファイルを Web サイトに変える道具。REF-01)が grdm-dev docs build で生成します(SPEC-02)。site/ を手で編集しないでください。

ライセンス

MIT License — 詳細は LICENSE を参照。


Glossary / 用語

Term English note 日本語注
repository A folder that stores code, documents, and configuration. コードや文書、設定を保管するフォルダ。
branch A separate version of the code that can be developed independently. コードの独立して開発できる別のバージョン。
installer A program that prepares other programs so they can run. 他のプログラムを実行可能にするための準備をするプログラム。
manifest A list that says exactly which version of each source repository we use. 使用する各ソースリポジトリのバージョンを正確に示すリスト。
MkDocs A tool that turns Markdown files into a website. Markdown のファイルを Web サイトに変える道具。

About

GakuNin RDM developer guide

Resources

Stars

3 stars

Watchers

8 watching

Forks

Releases

Packages

Contributors

Languages