brain-hackers_pepepper-mirror/wiki.brainux.org
1
0
Fork 0
mirror of https://github.com/brain-hackers/wiki.brainux.org synced 2024-12-23 04:30:05 +09:00
Code Issues Projects Releases Wiki Activity
098c0c3112
wiki.brainux.org/collections/_meta/how-to-edit-wiki.md
yanknvim 8300dcc9c0 指摘された問題点を修正 
多いため変更点についてはPRを参照してください
2023-07-04 19:12:19 +09:00

14 KiB
Raw Blame History

title tags excerpt
Wiki の編集方法とルール
Wiki
メンバー向け

準備

GitHub にログインした状態で Wiki を clone します。

$ git clone git@github.com:brain-hackers/wiki.brainux.org.git

2022年5月15日現在、Ubuntu 22.04 LTS では以下のコマンドで Ruby 3.0 がインストールされます。 お使いのディストリビューション標準のパッケージマネージャーで Ruby がインストールできない場合、 rbenv を使うなどして適宜最新バージョンをインストールしてください。

$ sudo apt install ruby-full

Rubyがインストールできたら、ruby -v コマンドで Ruby が実行されることを確認します。Ubuntu 22.04 LTS では以下のように出力されます。

$ ruby -v
ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux-gnu]

次に手元でのビルドに必要な依存関係をインストールします。

$ cd wiki.brainux.org
$ sudo gem install bundler
$ bundle install

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

$ make serve
Configuration file: /Users/takumi/dev/brain/wiki.brainux.org/_config.yml
            Source: /Users/takumi/dev/brain/wiki.brainux.org
       Destination: /Users/takumi/dev/brain/wiki.brainux.org/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
      Remote Theme: Using theme mmistakes/minimal-mistakes
       Jekyll Feed: Generating feed for posts
   GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data.
                    done in 53.672 seconds.
 Auto-regeneration: enabled for '/Users/takumi/dev/brain/wiki.brainux.org'
    Server address: http://127.0.0.1:4000
  Server running... press ctrl-c to stop.

次に、textlint と markdownlint を使うために Node.js とパッケージをインストールします。

$ cd wiki.brainux.org
$ npm install

Node.js のインストールの方法は問いませんが、不具合を減らすために、LTS を利用することをお勧めします。なお、2022年5月12日現在の LTS バージョンは v16 です。

また、Node.js のバージョン管理の1つの選択肢として、nodeenv を利用することも可能です。nodeenv を利用する場合は、毎回 env を activate することを忘れないでください。以下に、nodeenv を pip でインストールし、利用する例を示します。

$ pip install nodeenv
$ nodeenv -n 16.13.2 env
$ source ./env/bin/activate
(env) $ npm install

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

$ npm run textlint
$ npm run textlint-fix  # お好みで

markdownlint を動かして、正常に lint されるか試します。

$ npm run mdlint

当 Wiki では、EditorConfig を導入しています。

お使いのエディタにEditorConfig を導入し、既存のインデントに沿ってドキュメントを編集してください。

各種操作

1. a. ページを追加・削除する

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

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

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

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

文章に対するどのような変更も、Pull Request (PR) を提出して編集権限のあるメンバーからレビューを受けます。PR のレビュアーは自動で割り当てられます。

PR 提出前に、作業中のブランチが master ブランチの最新コミットから分岐しているか必ずチェックしてください。さもなくば、後で面倒な対処が必要となりレビュアーに迷惑がかかります。 不明確な場合は、以下のようにして最新コミットから分岐するように rebase してください。Conflict が発生した場合は適宜解決してください。

git checkout master
git pull
git checkout {作業中のブランチ}
git rebase master

PR のレビューに通ると変更がマージされ、公開されます。PR のタイトルや文章は丁寧に記述しましょう。詳細は Scrapbox の超説明・開発フローを参照してください。

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

  • @puhitaku
  • @tka3320
  • @Sasakura-ayato
  • @Codex340

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

ファイル名のルール

Wiki のページを生成している Jekyll は、md ファイルの名前から記事の日付や URL を生成します。以下のすべての条件を満たすようにしましょう。

  • YYYY-MM-DD-{英字とハイフンでできたタイトル}.md の形式にする
  • URL が冗長になるので日本語は使わない

記述ルール

Wiki の体裁に関するルールを列挙します。コミットの前に従っているかチェックしてください。一部のルールは textlint や markdownlint を使って機械的に調べたり修正できます。

文体

基本的には、技術文書のルールと同一です。助詞の使いすぎや表記ゆれは textlint でチェックできますが、機械的に検知できる範囲は限られているためよく心得ておいてください。

「ですます」と「だ・である」は統一する

Linter によるチェック: なし

Wiki 全体で「ですます」の形で統一します。

依頼する時はできるだけ「します」で締める

Linter によるチェック: なし

「〇〇してください」は長いので、「します」で極力統一します。不自然に映る場合は「してください」や「しましょう」を使っても OK です。この文書でも実際にどちらも使用しています。

繰り返しや冗長な表現をなくす

Linter によるチェック: textlint（部分的）

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

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

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

括弧は基本的に使わない

Linter によるチェック: なし

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

❌ 悪い例: Linux マシン（Ubuntu か Debian が入っていることが望ましい）を用意します。

⭕ 良い例: Ubuntu か Debian がインストールされた Linux マシンを用意します。

箇条書きには句読点を入れない

Linter によるチェック: なし

箇条書きは段落を表現する道具ではありません。よって、内容が極力短くなるようにしつつ、句読点を置かないようにします。

感情を排除する

Linter によるチェック: なし

極力スムーズに読める文章になるには、感情的表現を取り除く事が必須です。 文章は技術文書（レポート）のような無味乾燥なものにし、感情は Discord で共有しましょう。

コードブロックや画像と文章の関わりを示す

Linter によるチェック: なし

「以下にコマンド例を示します」などのように、文章と以下に連なる要素を関連付けます。

Markdown

Markdown はリッチなレンダリングがなくとも読めるシンタックスが特徴です。これを念頭に置いて、以下のルールに従ってください。 一部は markdownlint によって違反を検知できます。ここにない細かなルールは markdownlint の指示に従ってください。

必ずプレビューして確認する

ブラウザで文書を編集すると、コミット前に文書を HTML にレンダーするプレビューが利用可能です。ミスがないか確認してからコミットしましょう。

ローカルのコンソールやエディタで書く場合も、Markdown をプレビューできる環境を用意して確認してからコミットしましょう。

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

Windows で特に気を付けましょう。Git はコミット時に改行コードを LF のみに強制できます。

git config で

git config --global core.autocrlf input

と設定すると、コミット時に Unix style でコミットできます。

適切な空行を入れる

Linter によるチェック: あり

以下の箇所には1行空行を入れます。

  • 段落と段落の間
  • プレーンテキストとプレーンテキスト以外の要素の間
    • 節タイトル
    • 箇条書き
    • テーブル
    • 図
    • コードブロック
    • 引用

以下の箇所には2行空行を入れます。

  • 節と節の間

適切な空白を入れる

Linter によるチェック: なし

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

❌ 悪い例1: 1.あいうえお

⭕ 良い例1: 1. あいうえお

❌ 悪い例2: このコマンドには`-a`という引数を渡します。

⭕ 良い例2: このコマンドには `-a` という引数を渡します。

コードスパンとコードブロックを使い分ける

Linter によるチェック: なし

コードスパンとは、`ident`のように行の中に等幅で文字を入れるスパン要素を指します。

コードブロックとは

echo foo

のように新しい段落で等幅に文字を入れるブロック要素を指します。

コードスパンはコードの識別子や短いコマンドの例示に使い、コードブロックは複数行のプログラムや長いコマンドの例示に使用します。

例1: ls コマンドには -l というオプションがあります。

例2: ls コマンドでファイルの詳細情報を表示するには、以下のように実行します。

ls -l

明示的改行はバックスラッシュで行う

Linter によるチェック: なし

この節でいう明示的改行とは Hard line breaks のことで、空行による段落区切りや単一の LF による Soft line break ではなく確実に改行を入れることを指します。必要でない限りは使わないことが望ましいです。

明示的な改行の入れ方には行末にスペース2つを入れる方法とバックスラッシュを入れる方法がありまず。前者は通常不可視な上に意味合いがわかりづらいため、バックスラッシュを使用します。

一部ページの特殊な操作

「パッケージ一覧」を更新する際は、Python スクリプトを利用します。

まず、これを実行する場合は、以下のようにして依存関係をインストールします。

pip3 install -r ./tools/requirements.txt

次に、テーブルを生成します。

python3 ./tools/package_list.py

また、出力した結果を以下のようにしてクリップボードに直接コピーすることもできます。

# Ubuntu 
python3 ./tools/package_list.py | xsel -ib

# macOS 
python3 ./tools/package_list.py | pbcopy