search

waic / aria-practices

w3c/aria-practices
Other
0 stars 0 forks source link

翻訳の準備 #1

Open momdo opened 1 year ago

momdo commented 1 year ago
smitsunori commented 1 year ago

10月の議事録を拝見した上で、オリジナルのリポジトリ（aria-practices）の内容を確認してみました。

package.json を見た感じ、nodeで動かしているのはlintとテストのみで、特にビルドはしていないように見受けられました。もし翻訳の成果物としてlintやテストが不要であれば、いくつかのディレクトリは翻訳作業から排除できるのではと思います。 例えば /test/ ディレクトリなんかは、npm test コマンドでテストを実行するためにあるようです。

（WG4参加したばかりで、的外れなことを書いてしまってるかもしれません。その際はご指摘ください）

momdo commented 1 year ago

@smitsunori

コメントありがとうございます。

翻訳の成果物として、https://www.w3.org/WAI/ARIA/apg/からたどれる各ページの本文部分さえ翻訳できればよいので、 ご指摘のtestディレクトリは不要そうですね…（どうやって生成しているのか？の謎は深まるばかりですが

momdo commented 1 year ago

ビルドのシステムが謎、ということはw3.orgにあるファイルをコピーして、 ちまちまと翻訳していく、ということになるのかなと。

tsmd commented 1 year ago

ビルドシステムっぽいものを見つけました。 https://github.com/w3c/wai-aria-practices

ちゃんと見ないとですが、 aria-practices に push するとGitHub Workflowの仕組みで wai-aria-practices に同期されてデプロイされているようです。

JekyllなのでRuby環境を整えて、 暇を見て手元でビルドできるか試してみようと思います。

momdo commented 1 year ago

@tsmd ありがとうございます。 Readmeを見た感じ、最終的にはjekyllで生成してるっぽいですね…

tsmd commented 1 year ago

ちょびっと触ってみた結果を書きます。

要点

ちょっと詳しく

手元でAPGのサイトを確認することが可能

wai-aria-practicesのリポジトリはAPGのサイトの「ガワ」でした。ヘッダーフッター含むナビゲーションやCSSはこのリポジトリのものが使われています。

手元にRuby環境を用意してREADMEに書かれているコマンドをたたくと、手元に環境が立ち上がり、ビルドされたサイトをみることができます。

中身はaria-prarcticesのものが使われている

aria-practicesのcontentディレクトリ配下のコンテンツを取り込み、機械的な変換処理（けっこう力技）をしたのちにJekyllに食わせているようです。この変換処理のときに、もともと使われていたCSSをはぎ取って、Jekyllのテンプレートに含まれるCSSに差し替えることで見た目を変えています。

変換後のファイルもコミットされているので、このファイルを直接いじっても目的（？）は達成できそうな気もしますが、元ファイルを変更したほうが筋は良さそうです。

aria-practicesへの変更からのデプロイは自動化されている

ざっとみた限りなので見落としがあるかもしれませんが、本家は次のようなワークフローなのかと思います。

  1. aria-practicesにてHTMLを更新し、PRを作成
  2. GitHub Workflowが走り、wai-aria-practices側のJekyllでビルドされ、プレビュー環境がNetlify上に立ち上がる
  3. プレビュー環境をみながらレビューする、レビュー完了したらマージする
  4. マージされるとGitHub Workflowが走り、デプロイされる

PR上でプレビューを環境を見られるようにするためのタスクがややこしい作りになっていますが、翻訳作業ではAPGのサイトの見た目で確認できる必要は必ずしもなさそうなので、シンプルに作り替えることはできそうな気がします。

tsmd commented 1 year ago

リンク集