About

ありがたいことに↓にご協力させていただく事となりました～
https://twitter.com/crypt0crypt0___/status/1778785521323725089

todo

• ローカル環境でSui Documetation ページを表示
• forkしたレポジトリを使用して日本語翻訳・修正を試してみる
• forkしたレポジトリにupstreamをマージした際に「日本語に訳したがその後修正があった部分」だけconflictとして抽出できるのが理想
  • 更新頻度の高い本家Docsに追従することが目的
• Notionとの連携を探る
• Sui Documetationの更新をトラッキングし通知できるのか
• 翻訳作業を通してちゃっかり本家Docsに貢献をしたい（願望）

環境

Ubuntu 20.04.5 LTS (GNU/Linux 5.15.146.1-microsoft-standard-WSL2 x86_64)

ローカル環境でSui Documetationページを動かす

readme記載の手順で簡単にできました。
https://github.com/MystenLabs/sui/blob/main/docs/README.md

pnpmのインストールがまだの場合下記を参考にインストールしておく必要があります。
https://pnpm.io/ja/installation

Node.jsやnpmが未インストールの場合は

brew install corepack
corepack use pnpm@latest

以上で設定が完了しました。

Sui Documentationの変更をトラッキングする

何故やるか

Sui Documentationの更新も活発なため翻訳中に対象ページが更新されてしまうことがある。また翻訳後も定期的にメンテナンスが必要になる

fork元をマージできるようにするまで

自身のローカルにあるリモートリポジトリを確認する

$ git remote -v
origin  git@github.com:fukaeridesui/***.git (fetch)
origin  git@github.com:fukaeridesui/***.git (push)

fork元をupstreamとして登録

$ git remote add upstream git@github.com:***/***.git

***を対象のリポジトリに合わせて置換
git remote -vで追加されていることを確認する

fork元リポジトリをfetchしmerge
*mainブランチのみあれば問題ないのでupstream mainと指定
*マージの際はマージ用にブランチを作成しました

git fetch upstream main
git merge upstream/main

マージされたコミットの中でdocsを変更している場合はチェックする必要がある