Fix errors detected by textlint

2022-01-12 03:27:52 +09:00 · 2022-01-12 03:27:52 +09:00 · d9c57efb36
parent a25045de9b
commit d9c57efb36
10 changed files with 54 additions and 48 deletions
--- a/_posts/2021-12-04-beginner-get-started.md
+++ b/_posts/2021-12-04-beginner-get-started.md
@ -12,15 +12,15 @@ excerpt: ""
 <img src="/assets/images/happy.png">


-# はじめに
+# 始めに

-このページでは、SHARP Brain で Linux を動かす試みから生まれた Linux ディストリビューション **Brainux** を手軽に起動する方法をご紹介します。
+このページでは、SHARP Brain で Linux を動かす試みから生まれた Linux ディストリビューション **Brainux** を手軽に起動する方法を紹介します。

-Linux ディストリビューションは、2つの大きな要素としてカーネルとそれ以外のソフトウェアの組み合わせでできています。Brain の場合はカーネルを起動するブートローダーも SD カード上に必要なため、正確にはカーネル・ソフトウェア・ブートローダーのセットが必要になります。
+Linux ディストリビューションは、カーネルとそれ以外のソフトウェアの組み合わせです。Brain の場合はカーネルを起動するブートローダも SD カード上に必要なため、正確にはカーネル・ソフトウェア・ブートローダのセットが必要になります。

-リポジトリ [buildbrain](https://github.com/brain-hackers/buildbrain) では、Raspberry Pi と同様に SD カードに書き込むだけで起動可能にした SD イメージを公開しています。ちなみにカーネル・ソフトウェア・ブートローダーはどれも自力で準備することもできます。くわしくは本 Wiki の対応するページを参照してください。
+リポジトリ [buildbrain](https://github.com/brain-hackers/buildbrain) では、Raspberry Pi と同様に SD カードに書き込むだけで起動可能にした SD イメージを公開しています。ちなみにカーネル・ソフトウェア・ブートローダはどれも自力で準備することもできます。詳しくは本 Wiki の対応するページを参照してください。

-質問がある場合や開発に参加したい場合は、まず [Brain Hackers の Discord](https://github.com/brain-hackers/README) に参加して頂き、「雑談」チャンネルでお気軽にご質問ください。
+質問がある場合や開発に参加したい場合は、まず [Brain Hackers の Discord](https://github.com/brain-hackers/README) に参加していただき、「雑談」チャンネルでお気軽にご質問ください。


 # 対応している機種
@ -49,7 +49,7 @@ Linux ディストリビューションは、2つの大きな要素としてカ

 # SD カードに書き込む

-書き込むソフトは Windows / macOS / Linux のどれをお使いの場合でも利用可能な balenaEtcher がおすすめです。[公式サイト](https://www.balena.io/etcher/)にアクセスしてダウンロードしてください。
+書き込むソフトは Windows / macOS / Linux のどれをお使いの場合でも利用可能な balenaEtcher がお勧めです。[公式サイト](https://www.balena.io/etcher/)にアクセスしてダウンロードしてください。

 macOS もしくは Linux をお使いの場合は、ZIP を展開して取り出した .img ファイルを `dd` コマンドでそのまま書くことも可能です。

@ -73,7 +73,7 @@ macOS もしくは Linux をお使いの場合は、ZIP を展開して取り出

    - 正しい SD カードを選択しているか慎重に確認してください
    - 4GB 以上の SD カードであればなんでも使用可能です
-    - SD カードの性能がシステムの使用感に直結するため高速な SD カードを使用することをおすすめします
+    - SD カードの性能がシステムの使用感に直結するため高速な SD カードを使用することをお勧めします
    - 画像では 8GB の SD カードを選択しています

    <img src="/assets/images/etcher3.png" width=500px>
@ -82,7 +82,7 @@ macOS もしくは Linux をお使いの場合は、ZIP を展開して取り出

 4. "Flash!" をクリックして書き込みます

-    - 改めて正しい SD カードが選択されているか確認した上で書き込んでください
+    - あらためて正しい SD カードが選択されているか確認したうえで書き込んでください
    - 書き込みには管理者権限が必要なため管理者パスワードを入力します

    <img src="/assets/images/etcher5.png" width=500px>
@ -130,7 +130,7 @@ sudo dd if=~/Downloads/sdimage-2021-02-21-162410.img of=/dev/sdc bs=10M

 書き込み終わった SD カードを Brain に挿入し、リセットボタンを押します。Brain のロゴが表示されたあと U-Boot が起動し、すぐ後に Linux が起動します。

-本体の内蔵キーボードに対応している機種では、ログインシェルが表示されたらユーザー名とパスワードともに `root` でログインできます。非対応の機種では、電源供給が可能なタイプの OTG ケーブルを使用してキーボードを繋ぐと操作できます。
+本体の内蔵キーボードに対応している機種では、ログインシェルが表示されたらユーザー名とパスワードともに `root` でログインできます。非対応の機種では、電源供給が可能なタイプの OTG ケーブルを使用してキーボードをつなぐと操作できます。


 # 内蔵ハードウェア
--- a/_posts/2021-12-04-linux-build.md
+++ b/_posts/2021-12-04-linux-build.md
@ -57,7 +57,7 @@ Linuxのカーネルの準備ができたら、カーネルの上で動くアプ

 ## パッケージの追加方法 (任意)

-追加で欲しいパッケージを `./tools/setup_debian.sh` の51行目あたりに追記します。
+追加でほしいパッケージを `./tools/setup_debian.sh` の51行目あたりに追記します。

 実際に追記した例を以下に示します。

--- a/_posts/2021-12-04-linux-xorg.md
+++ b/_posts/2021-12-04-linux-xorg.md
@ -11,7 +11,7 @@ excerpt: Brain 特有の Xorg の設定について

 # Brain 特有の Xorg の設定について

-PW-Sx7 までは SoC に GPU が載っておらず、framebuffer (fbdev) のみが利用可能です。つまり、お手元の Linux マシンで Xorg が GPU と通信するときに使う仕組み (DRM, DRI) は利用できません。設定ファイルに fbdev を使用するように明示的に書くことで Xorg が動かせます。
+PW-Sx7 までは SoC に GPU が載っておらず、framebuffer (fbdev) のみが利用可能です。つまり、お手元の Linux マシンで Xorg が GPU と通信するときに使うしくみ (DRM, DRI) は利用できません。設定ファイルに fbdev を使用するよう明示的に書くことで Xorg が動かせます。


 # xorg.conf
--- a/_posts/2021-12-04-meta-how-to-edit-wiki.md
+++ b/_posts/2021-12-04-meta-how-to-edit-wiki.md
@ -39,7 +39,7 @@ $ cd wiki.brainux.org
 $ bundle install
 ```

-ビルドとプレビューができることを確認します。下記のように `bundle exec jekyll serve` を実行すると localhost:4000 でサーバーが
+ビルドとプレビューができることを確認します。下記のように `bundle exec jekyll serve` を実行すると localhost:4000 でサーバが
 起動している旨のメッセージが出るので、メッセージが見え次第ブラウザで `localhost:4000` を開いてプレビューできます。

 ```sh
@ -65,7 +65,7 @@ $ cd wiki.brainux.org
 $ npm install
 ```

-Node.jsのインストール方法とバージョンは動けば何でも良いです。まずはパッケージマネージャーでインストールしたNode.jsを使ってみて、上手く行かなければnodeenv（nodenvではない！）を使う以下の方法を試してください。nodeenvでインストールした場合は、毎回envをactivateするのを忘れないでください。
+Node.jsのインストール方法とバージョンは動けば何でも良いです。まずはパッケージマネージャーでインストールしたNode.jsを使ってみて、うまく行かなければnodeenv（nodenvではない！）を使う以下の方法を試してください。nodeenvでインストールした場合は、毎回envをactivateするのを忘れないでください。

 ```sh
 $ pip install nodeenv
@ -74,7 +74,7 @@ $ source ./env/bin/activate
 (env) $ npm install
 ```

-Textlintを動かして、正常にlintされるか試します。自動修正は`npm run fix`で発動できますが、意図しない修正が起こる可能性があるためあまりおすすめしません。
+Textlintを動かして、正常にlintされるか試します。`npm run fix`で発動する自動修正は、誤検知も意図せず修正してしまう可能性があるため事前によくチェックしてから実行してください。

 ```sh
 $ npm run textlint
@ -95,22 +95,28 @@ $ npm run mdlint

 - 新たにブランチを作成する
  - 後で Pull Request として提出するため、`master` ブランチには直接コミットしないでください
- `_posts` ディレクトリにある他のファイルを参考にして md ファイルを追加します
+- `_posts` ディレクトリにあるほかのファイルを参考にして md ファイルを追加します
  - 例: `2038-1-19-doomsday.md`
 - 記事内容を記述します
- ひととおり追加と削除が終わったら `pull -r`, commit, push します
+- `npm textlint` と `npm mdlint` を実行し、エラーが出ないことを確認します
+  - もし誤検知があった場合はルールを修正するかレビュアーと相談してください
+  - エラー箇所をどうしても押し通したい場合はそこだけlintを無効化するよう記述してレビュアーに説明してください
+- 一通り追加と削除が終わったら `pull -r`, commit, push します


 ## 1. b. ページを編集する

 - 記事内容を記述します
- ひととおり編集が終わったら `pull -r`, commit, push します
+- `npm textlint` と `npm mdlint` を実行し、エラーが出ないことを確認します
+  - もし誤検知があった場合はルールを修正するかレビュアーと相談してください
+  - エラー箇所をどうしても押し通したい場合はそこだけlintを無効化するよう記述してレビュアーに説明してください
+- 一通り編集が終わったら `pull -r`, commit, push します


 ## 2. 変更を提出する・レビューを受ける・マージしてもらう

-文章に対するどのような変更も、必ずドキュメント編集権限のあるメンバー最低1人にレビューを依頼します。
-このレビューに通ると変更がマージされ、公開されます。
+文章に対するどのような変更も、必ずPull Requestを提出してドキュメント編集権限のあるメンバー最低1人にレビューを依頼します。
+このレビューに通ると変更がマージされ、公開されます。PRのタイトルや文章は丁寧に記述しましょう。詳細はScrapboxの[超説明・開発フロー](https://scrapbox.io/brain-hackers/%E8%B6%85%E8%AA%AC%E6%98%8E%E3%83%BB%E9%96%8B%E7%99%BA%E3%83%95%E3%83%AD%E3%83%BC)を参照してください。

 2021年12月現在、編集権限のあるメンバーは以下の通りです。

@ -118,7 +124,7 @@ $ npm run mdlint
 - @tka3320

 注意！GitHub の Brain Hackers organization のメンバーでない人はレビューを依頼できないので、
-Discord にてメンバー追加依頼をしてメンバになってから Pull Request を提出しましょう。
+Discord にてメンバー追加依頼をしてメンバーになってから Pull Request を提出しましょう。


 # ファイル名のルール
@ -131,7 +137,7 @@ Wiki のページを生成している Jekyll は、md ファイルの名前か

 # 記述ルール

-Wiki の体裁について以下にルールを列挙します。コミットの前にこれらに従っているかチェックしてください。Textlint はまだありません。
+Wiki の体裁に関するルールを列挙します。コミットの前に従っているかチェックしてください。一部のルールはTextlintやmarkdownlintを使って機械的に調べたり修正できます。


 ## 文体
@ -152,14 +158,14 @@ Wiki 全体で「ですます」の形で統一します。
 ### 繰り返しや冗長な表現をなくす

 冗長な表現を組み込んでしまうことは多いので、極限まで削ります。
-「など」「いろいろ」「といった」「〇〇することができます」は使いがちですので特に気をつけましょう。
+「など」「いろいろ」「といった」「〇〇できます」は使いがちですので特に気を付けましょう。

 :x: 悪い例: このコマンドを使えば、Linux を起動することなどが可能です。

 :o: 良い例: このコマンドで、Linux を起動できます。


-### カッコは基本的に使わない
+### 括弧基本的に使わない

 どうしても必要な場合は、名詞の別名や補足といった1〜2単語で済む体言を入れるだけにします。

@ -198,7 +204,7 @@ Markdown はリッチなレンダリングがなくとも読めるシンタッ

 ### 改行コードは LF に統一する

-Windows で特に気をつけましょう。Git は[コミット時に改行コードを LF のみに強制](https://qiita.com/uggds/items/00a1974ec4f115616580)できます。
+Windows で特に気を付けましょう。Git は[コミット時に改行コードを LF のみに強制](https://qiita.com/uggds/items/00a1974ec4f115616580)できます。

 `git config` で

@ -229,7 +235,7 @@ git config --global core.autocrlf input

 ### 適切な空白を入れる

-プレーンテキスト以外の要素の前後に適切な空白がないと表示がおかしくなるケースがあります。この文書は GitHub での表示に限られるため空白がなくても大丈夫ですが、エディタでのシンタックスハイライトが上手くいかなくなることがありますので気をつけましょう。
+プレーンテキスト以外の要素の前後には適切な空白を入れ、表示がおかしくなるリスクを減らしましょう。この文書はWikiでの表示に限られるため空白を欠いても大丈夫ですが、エディタでのシンタックスハイライトに失敗することがありますので気を付けましょう。

 :x: 悪い例1: `1.あいうえお`

--- a/_posts/2021-12-04-roadmap.md
+++ b/_posts/2021-12-04-roadmap.md
@ -25,29 +25,29 @@ excerpt: Brainux が自分の電子辞書にどれくらい対応しているか

 |キーボードの世代|対応済|説明|
 |:--|:-:|:--|
-|3桁世代||SoC が直接キーマトリクスを読む|
-|4桁世代, Sx1 〜 Sx2|:white_check_mark:|MPU がキーマトリクスを読み SoC に I²C で送信|
-|Sx3 〜 Sx7||SoC が直接キーマトリクスを読む|
+|3桁世代||SoC が直接キーマトリックスを読む|
+|4桁世代, Sx1 〜 Sx2|:white_check_mark:|MPU がキーマトリックスを読み SoC に I²C で送信|
+|Sx3 〜 Sx7||SoC が直接キーマトリックスを読む|
 |x1|詳細不明||


 # 画面開閉検知

- 開閉イベントの伝達はキーイベントと同じ経路を辿る
+- 開閉イベントの伝達はキーイベントと同じ経路をたどる
 - キーボードの実装に依存する

 |キーボードの世代|対応済|説明|
 |:--|:-:|:--|
-|3桁世代||SoC が直接キーマトリクスを読む|
-|4桁世代, Sx1 〜 Sx2||MPU がキーマトリクスを読み SoC に I²C で送信|
-|Sx3 〜 Sx7||SoC が直接キーマトリクスを読む|
+|3桁世代||SoC が直接キーマトリックスを読む|
+|4桁世代, Sx1 〜 Sx2||MPU がキーマトリックスを読み SoC に I²C で送信|
+|Sx3 〜 Sx7||SoC が直接キーマトリックスを読む|
 |x1||詳細不明||


 # 音

 - Brain に内蔵されているスマートアンプには大きく分けて Yamaha 系と Rohm 系がある
- 録音も再生も2021年2月23日現在解析中で非対応
+- 録音と再生は2021年2月23日現在解析中で非対応


 # タッチパネル
@ -56,7 +56,7 @@ excerpt: Brainux が自分の電子辞書にどれくらい対応しているか
 - 世代によるハードウェアの差分は不明


-# 電源コントローラー
+# 電源コントローラ

 - 2021年2月23日現在未対応のため充電状態の表示などは一切不可

--- a/_posts/2021-12-04-tips-otg.md
+++ b/_posts/2021-12-04-tips-otg.md
@ -11,7 +11,7 @@ excerpt: 動作可否が確認されたケーブルの一覧

 # 使える USB OTG ケーブル一覧

-Brainux の初期状態では、USB コントローラーはホストとして動作するようになっています。OTG ケーブルを使用すると好きなデバイスを接続することができます。Brain 自身は VBUS (5V) を供給する能力はないので、電源が別途供給可能な OTG ケーブルを使用する必要があります。
+Brainux の初期状態では、USB コントローラはホストとして動作するようになっています。OTG ケーブルを使用すると好きなデバイスを接続できます。Brain 自身は VBUS (5V) を供給する能力はないので、電源が別途供給可能な OTG ケーブルを使用する必要があります。

 - [RouteR RUH-OTGU4](https://amz.run/4Kue)
 - [AINEX USB-120R](https://www.sengoku.co.jp/mod/sgk_cart/detail.php?code=EEHD-5EHA)
--- a/_posts/2021-12-04-tips-swap.md
+++ b/_posts/2021-12-04-tips-swap.md
@ -11,16 +11,16 @@ excerpt: ""

 # スワップの作成を推奨します

-Brain の DRAM は 128MB しかないので、簡単にメモリが食いつぶされます。この時、スワップがないと OOM Killer により重要なプロセスが終了される危険性があるため、スワップを作成することをおすすめします。
+Brain の DRAM は 128MB しかないので、簡単にメモリが食いつぶされます。OOM Killer により重要なプロセスを終了される危険があるため、スワップを作成することをお勧めします。

-2021年2月23日現在のリリースではまだスワップ領域を標準で設定していません。Brain Hackers では将来のリリースで標準でスワップを設定することを検討しています。
+2021年2月23日現在のリリースではまだスワップ領域を標準で設定していません。Brain Hackers では将来のリリースで最初からスワップを設定することを検討しています。


 # 作成方法

 1. 以下のコマンドを実行して、スワップのための領域を確保します

-    今回の例では、256MB（これ以上を推奨）の領域を確保しています。他の容量にしたい場合は適宜 `bs` や `count` の値を変えてください。
+    今回の例では、256MB（これ以上を推奨）の領域を確保しています。ほかの容量にしたい場合は適宜 `bs` や `count` の値を変えてください。

    ```sh
    dd if=/dev/zero of=/swapfile bs=1M count=256
--- a/_posts/2021-12-04-tips-usb-ethernet-gadget.md
+++ b/_posts/2021-12-04-tips-usb-ethernet-gadget.md
@ -13,18 +13,18 @@ excerpt: PC と USB ケーブル1本で接続できる便利な仕組みとそ

 # USB Gadget とは？

-コンピューターがあたかも USB デバイスであるかのように振る舞う仕組みです。
+コンピュータがあたかも USB デバイスであるかのように振る舞うしくみです。


 # Why USB Gadget?

-インターネットに接続可能なパソコンに USB で Brain を接続するだけで Brain からインターネットに出たり、パソコンと Brain で双方向に SSH したりできるようになります。電池切れの心配もありません。
+インターネットに接続可能なPCと Brain を接続するだけで Brain からインターネットに出たり、PCと Brain で双方向に SSH したりできます。電池切れの心配もありません。


-# USB コントローラーの動作モードを変更する
+# USB コントローラの動作モードを変更する

-初期状態では Brain の USB コントローラーはホストとして動作するため、このままではデバイスになることができません。
-2022年1月8日現在ではまだありませんが、コントローラーの動作モードを簡単に切り替えるスクリプトを用意する予定です。
+初期状態では Brain の USB コントローラはホストとして動作するため、このままではデバイスになることができません。
+2022年1月8日現在ではまだありませんが、コントローラの動作モードを簡単に切り替えるスクリプトを用意する予定です。

 手動で変更するには、以下の手順に従ってください。

@ -159,9 +159,9 @@ sudo reboot
   ```


-# パソコン側の対応作業
+# PC側の対応作業

 Windows / Mac / Linux すべてで利用可能です。（注: 2021年2月23日現在、上記スクリプトでは Windows と macOS で認識しないことを確認しており、修正予定です）

-パソコンを通してインターネットに出るために、ネットワーク接続の共有設定が必要になります。OS ごとに設定方法は異なりますので、別途設定してください。
+PCを通してインターネットへ出るために、ネットワーク接続の共有設定が必要になります。OS ごとに設定方法は異なりますので、別途設定してください。

--- a/_posts/2021-12-04-tips-web-browser.md
+++ b/_posts/2021-12-04-tips-web-browser.md
@ -12,7 +12,7 @@ excerpt: Brainux で利用可能な Web ブラウザについて

 # グラフィカルブラウザ

-**グラフィカルブラウザを使うのは困難です！** PW-Sx7 までの Brain が搭載している SoC は初代 Raspberry Pi のクロック周波数の約半分の速度で動作し、メモリ容量も半分以下の 128MB しかありません。つまり、インターネットブラウジングは現実的ではありません。例えば、[極めて高速に表示されることで有名な著名人のサイト](http://abehiroshi.la.coocan.jp/)の表示に実測15秒ほどかかります。また、Twitter は表示不可能です。
+**グラフィカルブラウザを使うのは困難です！** PW-Sx7 までの Brain が搭載している SoC は初代 Raspberry Pi のクロック周波数の約半分の速度で動作し、メモリ容量も半分以下の 128MB しかありません。つまり、インターネットブラウジングは非現実的です。たとえば、[極めて高速に表示されることで有名な著名人のサイト](http://abehiroshi.la.coocan.jp/)の表示に実測15秒ほどかかります。また、Twitter は表示不可能です。


 ## Midori
@ -31,5 +31,5 @@ DISPLAY=:0 midori

 # テキストブラウザ

-Lynx や w3m は非常にスムーズに動作します。現実的なスピードで Web サイトを閲覧するにはこれらをおすすめします。
+Lynx や w3m はスムーズに動作します。現実的なスピードで Web サイトを閲覧するにはこれらをお勧めします。

--- a/_posts/2021-12-04-u-boot-build.md
+++ b/_posts/2021-12-04-u-boot-build.md
@ -19,7 +19,7 @@ excerpt: ""

 # 環境の構築

-[Linux のビルド](/linux/linux-build/)の頁で既に構築している場合は飛ばします。
+[Linux のビルド](/linux/linux-build/)の頁ですでに構築している場合は飛ばします。


 ## 依存関係のインストール