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

Merge pull request #11 from brain-hackers/2022-05-11

Browse Source 
Add how to install Bundler
This commit is contained in:
佐桜 彩斗 2022-05-12 01:00:01 +09:00 committed by GitHub
commit 11199bf7d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
_posts/2021-12-04-meta-how-to-edit-wiki.md
View File

@ -32,10 +32,12 @@ ruby 2.7.0p0 (2019-12-25 revision 647ee6f091) [x86_64-linux-gnu]
``` ```
次に手元でのビルドに必要な依存関係をインストールします。 次に手元でのビルドに必要な依存関係をインストールします。
インストールには Bundler を用います。Bundler は gem を使ってインストールしてください。
```sh ```sh
$ cd wiki.brainux.org $ cd wiki.brainux.org
$ sudo gem install bundler
$ bundle install $ bundle install
``` ```
@ -58,14 +60,16 @@ Configuration file: /Users/takumi/dev/brain/wiki.brainux.org/_config.yml
Server running... press ctrl-c to stop. Server running... press ctrl-c to stop.
```` ````
次に、Textlintとmarkdownlintを使うためにNode.jsとパッケージをインストールします。 次に、textlint と markdownlint を使うために Node.js とパッケージをインストールします。
```sh ```sh
$ cd wiki.brainux.org $ cd wiki.brainux.org
$ npm install $ npm install
``` ```
Node.jsのインストール方法とバージョンは動けば何でも良いです。まずはパッケージマネージャーでインストールしたNode.jsを使ってみて、うまく行かなければnodeenv（nodenvではない！）を使う以下の方法を試してください。nodeenvでインストールした場合は、毎回envをactivateするのを忘れないでください。 Node.js のインストールの方法は問いませんが、不具合を減らすために、LTS を利用することをお勧めします。なお、2022年5月12日現在の LTS バージョンは [v16](https://nodejs.org/en/about/releases/) です。
また、Node.js のバージョン管理の1つの選択肢として、nodeenv を利用することも可能です。nodeenv を利用する場合は、毎回 env を activate することを忘れないでください。以下に、nodeenv を pip でインストールし、利用する例を示します。
```sh ```sh
$ pip install nodeenv $ pip install nodeenv
@ -74,7 +78,7 @@ $ source ./env/bin/activate
(env) $ npm install (env) $ npm install
``` ```
Textlintを動かして、正常にlintされるか試します。`npm run textlint-fix`で発動する自動修正は、誤検知も意図せず修正してしまう可能性があるため事前によくチェックしてから実行してください。 textlint を動かして、正常に lint されるか試します。`npm run textlint-fix` で発動する自動修正は、誤検知も意図せず修正してしまう可能性があるため事前によくチェックしてから実行してください。
```sh ```sh
$ npm run textlint $ npm run textlint
@ -98,7 +102,7 @@ $ npm run mdlint
- `_posts` ディレクトリにあるほかのファイルを参考にして md ファイルを追加します - `_posts` ディレクトリにあるほかのファイルを参考にして md ファイルを追加します
- 例: `2038-1-19-doomsday.md` - 例: `2038-1-19-doomsday.md`
- 記事内容を記述します - 記事内容を記述します
- `npm textlint` と `npm mdlint` を実行し、エラーが出ないことを確認します - `npm run textlint` と `npm run mdlint` を実行し、エラーが出ないことを確認します
- もし誤検知があった場合はルールを修正するかレビュアーと相談してください - もし誤検知があった場合はルールを修正するかレビュアーと相談してください
- エラー箇所をどうしても押し通したい場合はそこだけ lint を無効化するよう記述してレビュアーに説明してください - エラー箇所をどうしても押し通したい場合はそこだけ lint を無効化するよう記述してレビュアーに説明してください
- 一通り追加と削除が終わったら `pull -r`, commit, push します - 一通り追加と削除が終わったら `pull -r`, commit, push します
@ -107,7 +111,7 @@ $ npm run mdlint
## 1. b. ページを編集する ## 1. b. ページを編集する
- 記事内容を記述します - 記事内容を記述します
- `npm textlint` と `npm mdlint` を実行し、エラーが出ないことを確認します - `npm run textlint` と `npm run mdlint` を実行し、エラーが出ないことを確認します
- もし誤検知があった場合はルールを修正するかレビュアーと相談してください - もし誤検知があった場合はルールを修正するかレビュアーと相談してください
- エラー箇所をどうしても押し通したい場合はそこだけ lint を無効化するよう記述してレビュアーに説明してください - エラー箇所をどうしても押し通したい場合はそこだけ lint を無効化するよう記述してレビュアーに説明してください
- 一通り編集が終わったら `pull -r`, commit, push します - 一通り編集が終わったら `pull -r`, commit, push します
@ -115,13 +119,15 @@ $ npm run mdlint
## 2. 変更を提出する・レビューを受ける・マージしてもらう ## 2. 変更を提出する・レビューを受ける・マージしてもらう
文章に対するどのような変更も、必ずPull Requestを提出してドキュメント編集権限のあるメンバー最低1人にレビューを依頼します。 文章に対するどのような変更も、必ず Pull Request (PR) を提出してドキュメント編集権限のあるメンバー最低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)を参照してください。 このレビューに通ると変更がマージされ、公開されます。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月現在、編集権限のあるメンバーは以下の通りです。 2022年5月現在、編集権限のあるメンバーは以下の通りです。
- @puhitaku - @puhitaku
- @tka3320 - @tka3320
- @Sasakura-ayato
- @Codex340
注意！ GitHub の Brain Hackers organization のメンバーでない人はレビューを依頼できないので、 注意！ GitHub の Brain Hackers organization のメンバーでない人はレビューを依頼できないので、
Discord にてメンバー追加依頼をしてメンバーになってから Pull Request を提出しましょう。 Discord にてメンバー追加依頼をしてメンバーになってから Pull Request を提出しましょう。
@ -137,7 +143,7 @@ Wiki のページを生成している Jekyll は、md ファイルの名前か
# 記述ルール # 記述ルール
Wiki の体裁に関するルールを列挙します。コミットの前に従っているかチェックしてください。一部のルールはTextlintやmarkdownlintを使って機械的に調べたり修正できます。 Wiki の体裁に関するルールを列挙します。コミットの前に従っているかチェックしてください。一部のルールは textlint や markdownlint を使って機械的に調べたり修正できます。
## 文体 ## 文体