ドキュメントへの貢献

XRP Ledger開発者ポータルへの貢献を検討いただきありがとうございます！

私たちは、あなたが興味を持ってくださっていることにとても感動しています。XRP Ledger(XRPL)へ貢献することは、XRPLついて学ぶ素晴らしい機会です。

私たちはあなたのプルリクエストを喜んでレビューします。プロセスをできるだけ円滑に進めるため、このドキュメントを読み、記載されているガイドラインに従ってください。

当サイトについて

XRPL Dev Portalでは、開発者が開発を開始するためのサンプルコードやその他の情報を含む、XRP Ledgerの包括的なドキュメントを提供しています。

本プロジェクトの公式リポジトリはhttps://github.com/XRPLF/xrpl-dev-portal となっています。投稿の著作権はそれぞれの投稿者に帰属しますが、MITライセンス の下で提供されなければなりません。

リポジトリの構成

• assets/ - サイトのテンプレートで使用される静的ファイル。
• content/ - ドキュメントを構築するために使用されるソースファイル。ほとんどがMarkdownです。
  • content/_code-samples/ - ドキュメントで使用または参照されているコードサンプル。可能な限り、これらは完全に機能する/実行可能なスクリプトです。
  • content/_img-sources/ - ドキュメントで使用されている画像の元ファイル。.uxfファイルはUmlet で作成されたダイアグラムです。
  • content/_snippets/ - Dactylプリプロセッサを使用して、他のコンテンツファイルに挿入される再利用可能なMarkdownテキストの断片。
• img/ - ドキュメントコンテンツで使用される画像。
• template/ - HTMLを構築するためのテンプレートファイル。
• tool/ - フィルター、スタイルチェッカー・ルール等のスクリプト。
• styles/ - assetsフォルダにCSSファイルを生成するための元ファイル(SCSS)。
• dactyl-config.yml - サイトのメタデータを含むメイン設定ファイル。設定ファイルのフォーマットについては、設定フォーマットを参照してください。

プルリクエストが承認されるための条件

レビューやマージが承認される前に、それぞれのプルリクエストは以下の条件を満たしていなければなりません。 - インテグレーションテストに合格すること。 - レビューの準備が整うまで、Draft としてください。 - このリポジトリのコード規約 を遵守してください。

Dactylのセットアップ

ポータルはDactyl を使用して構築されています。

DactylにはPython 3 が必要です。pip を使ってインストールしてください：

pip3 install dactyl

サイトの構築

このリポジトリでは、Dactyl を使用して、すべてのドキュメントのHTMLをビルドしています。Dactylのセットアップを行った後、プロジェクトのルートディレクトリからサイトをビルドすることができます。

dactyl_build

生成されたコンテンツはout/ディレクトリに出力されます。これらのコンテンツはウェブブラウザでファイルとして開いたり、ウェブサーバで静的コンテンツとして扱うことができます。

ルートディレクトリからリンクチェックやスタイルチェックを実行することもできます。

リンクチェックは出力フォルダを空にしてからビルドしてください。

dactyl_link_checker

スタイルチェックは実験的なものです。

dactyl_style_checker

設定ファイルのフォーマット

このリポジトリでは、dactyl-config.ymlファイルのメタデータとページのfrontmatter を使って、ヘッダー、フッター、サイドバー、パンくずリストなどのナビゲーション要素を生成します。

新しいページを追加する場合、dactyl-config.ymlファイルのpages配列の適切な位置に追加する必要があります。追加例は次のようになります。

    -   md: concepts/the-rippled-server/the-rippled-server.md
        targets:
            - en
            - ja # 翻訳コンテンツがない場合、全てのターゲットを対象とします。

Markdownファイル自体は、以下のようなfrontmatterで始まる必要があります。

---
html: the-rippled-server.html
parent: concepts.html
template: pagetype-category.html.jinja
blurb: rippled is the core peer-to-peer server that manages the XRP Ledger. This section covers concepts that help you learn the "what" and "why" behind fundamental aspects of the rippled server.
---

少なくとも、ほとんどのページには html、parent、blurb フィールドが必要です(さらに、設定ファイルではmdフィールドとtargetsフィールドも必要です)。ここに、またはページの設定ファイルのエントリに任意のキーと値のペアを記述することができますが、以下のものが関係しています。

規約

ページを作成する際には、以下の規約に従ってください。

• HTMLのファイル名とMDのファイル名は、拡張子を除いて完全に一致していなければなりません。
• ファイル名は"and"や"the"のような単語を含め、ページのタイトルと密接に一致する必要がありますが、スペースや句読点の代わりにハイフンを使用し、すべて小文字にする必要があります。例えば、cash-a-check-for-an-exact-amount.mdのようにします。ページのタイトルを変更した場合は、ファイル名も変更する必要があります。(すでに別のURLで公開されている場合は、古いURLからのリダイレクトを残してください)
• 常にh1ヘッダーでページを始めます。
• ページの一番上のh1アンカーにはリンクせず、アンカーなしでページ自体にリンクしてください。これは翻訳時のリンク切れを防ぐのに役立ちます。以降のヘッダーへのリンクは問題ありません。
• ページのタイトルに書式( italics やcode fontなど)を使わないでください。
• Markdownファイルのテキストを折り返さないでください。
• コードサンプルの場合、行は80文字以下になるようにしてください。
• 迷ったら、Ciro SantilliのMarkdownスタイルガイド (Writability Profile) に従ってください。

• ランディングページはサブフォルダに入れ、フォルダと同じファイル名とします。例えば、"Accounts"ページグループのランディングページはaccounts/accounts.mdで、HTMLファイル名はaccounts.htmlです。

  注意: index.mdは利用しないでください。

• Markdownやコードサンプルでは、インデントにタブ文字を使用しないでください。JavaScriptのコードサンプルでは、1字下げにつき2個のスペースを使用してください。

技術用語

以下の単語やフレーズを説明通りに使用してください。

Frontmatterのフィールド

このリポジトリのMarkdownファイルのfronmatterは任意のキーと値のペアを含むことができます。以下のフィールドは特定の用途や意味を持ちます。