Redpenの指摘を修正

[equal-l2]

Redpenに指摘された部分を大方修正しました。 ただしいくつかよくわからない指摘や修正が難しいものがあったので、そちらの修正方法を教えてもらえればと思います。

ついでに、運用上不便があったので以下の変更をしました。

• Redpen/を.gitignoreに追加
• Redpen用のdocker-entrypoint.shに実行権限を付与

[equal-l2]

現時点のResult.txt:

Document: ./CHANGELOG.md
    Line: 1, Offset: 0
        Sentence: CHANGELOG
            EmptySection: The section "CHANGELOG" is empty.
    Line: 2, Offset: 0
        Sentence: 2.0.1
            EmptySection: The section "2.0.1" is empty.
    Line: 5, Offset: 0
        Sentence: 2.0.0
            EmptySection: The section "2.0.0" is empty.

Document: ./CONTRIBUTING.md
    Line: 1, Offset: 0
        Sentence: どうやって docker で開発するのか
            EmptySection: The section "どうやって docker で開発するのか" is empty.
    Line: 5, Offset: 2
        Sentence: config.ts ファイルの生成 cp config.ts.sample config.ts
            SentenceLength: The length of the sentence (47) exceeds the maximum of 40.
    Line: 23, Offset: 0
        Sentence: 文字化け及び改行コードエラーが発生する場合
            KatakanaEndHyphen: Found invalid Katakana end-hyphen "コードエラー".
    Line: 30, Offset: 0
        Sentence: mac ，linux の方
            EmptySection: The section "mac ，linux の方" is empty.
    Line: 36, Offset: 0
        Sentence: 3. config.ts の DB に関する記述を変更する
            EmptySection: The section "3. config.ts の DB に関する記述を変更する" is empty.
    Line: 66, Offset: 0
        Sentence: Docker で開発しない人向け
            EmptySection: The section "Docker で開発しない人向け" is empty.
    Line: 68, Offset: 0
        Sentence: 1. config.ts を変更
            EmptySection: The section "1. config.ts を変更" is empty.
    Line: 70, Offset: 2
        Sentence: config.ts ファイルの生成 cp config.ts.sample config.ts
            SentenceLength: The length of the sentence (47) exceeds the maximum of 40.
    Line: 75, Offset: 0
        Sentence: 2. config.ts に MySQL の情報を書く
            EmptySection: The section "2. config.ts に MySQL の情報を書く" is empty.
    Line: 90, Offset: 0
        Sentence: 3. DB をマイグレート
            EmptySection: The section "3. DB をマイグレート" is empty.

Document: ./README.md
    Line: 1, Offset: 0
        Sentence: ams-backend-nodejs
            EmptySection: The section "ams-backend-nodejs" is empty.
    Line: 9, Offset: 0
        Sentence: 関係のあるリポジトリ一覧
            EmptySection: The section "関係のあるリポジトリ一覧" is empty.
    Line: 35, Offset: 0
        Sentence: API の動作はこちらに記載しています
            EmptySection: The section "API の動作はこちらに記載しています" is empty.

Document: ./docs/OpenAPI/how_to_generate.md
    Line: 1, Offset: 0
        Sentence: どうやって OpenAPI 用の HTML を作成するのか
            EmptySection: The section "どうやって OpenAPI 用の HTML を作成するのか" is empty.
    Line: 5, Offset: 0
        Sentence: node.js インストールまたは Docker，WSL 等使って，node を利用出来るようにしておく．
            SentenceLength: The length of the sentence (53) exceeds the maximum of 40.

Document: ./docs/deployment.md
    Line: 1, Offset: 0
        Sentence: Deployment
            EmptySection: The section "Deployment" is empty.
    Line: 3, Offset: 0
        Sentence: PM2のインストール（まだの場合）
            EmptySection: The section "PM2のインストール（まだの場合）" is empty.
    Line: 9, Offset: 0
        Sentence: 新しくリリースする場合
            EmptySection: The section "新しくリリースする場合" is empty.
    Line: 20, Offset: 0
        Sentence: config.ts および node_modules フォルダを上書き・削除しないように注意してください
            SentenceLength: The length of the sentence (52) exceeds the maximum of 40.

[ghost]

@equal-l2 @h-takeyeah 別にどっちでも動くので、ルールとして統一したほうが良いのでは？と思ったのがディレクトリを無視したいとき、 .gitignore で Redpen と記載するか Redpen/ にするか、は決めといたほうが良いと思いました。

後、まだCIの修正点は残っているので直せるところは治しておきます。

[equal-l2]

@Stroheim001 ログを見る限りwgetとtarは最初から入っているようなので、特別に理由がなければapt-getで入れる必要はないと思います。 あと、自分の変更とのマージの結果 sudo ACCEPT_EULA=Y だけが残ってしまっているので、お手数ですがそちらで消しておいてもらえますか？

[ghost]

@equal-l2 了解です。(wgetとtarあるんか～い)

不要な部分削除してpushします。

[equal-l2]

@h-takeyeah 確認の上マージお願いします 追記: 下のコメントの件が終わってからでお願いします

[equal-l2]

@Stroheim001 Dockerの方もaptなしでwgetやtarが使えるか確認してもらえますか？

[ghost]

@equal-l2 Dockerは参照してるイメージが違うのと、そもそもDockerはvimとかnanoすら入ってないレベルなのと、dockerhub見た感じ、本当にjavaを動かすのに必要最低限しか入ってないと思います。

まあ、経験上の話ですけど

[ghost]

@equal-l2 すみません。Dockerでもwgetとtarいりませんでした。

いるときといらないときがあるのでDockerは気を付けないといけないですね...

[h-takeyeah]

@Stroheim001

個人的には句読点が必要な状況に陥らないようにするか、句読点を許容する設定に変えるかした方がいいと思います。

すでにそうなっているようですが(，)と(．)を使用するようになっていればよいと思います．それから，これは質問なのですが，今の設定だと行末の(．)は削除されますよね．技術文書としてはメジャーな書き方なのでしょうか？本や記事だとあまり見かけないので気になりました．

[ghost]

@h-takeyeah Redpenの設定で見つけたやつを片っ端からぶち込んだので、エラーが出やすくなっていると思います。 青シャツさんと二人で、句点は.で良いなのか普通に。にして欲しいのかは打合せするかdiscordやslackで打ち合わせしても良いと思います。

ドキュメントは我々だけのものではありません。あくまで次の代に引き継いで運用してもらうためのモノです。

そこでリバースエンジニアリングを簡単にするための手段でしかないのですから、読みにくければ話にならない、というのは分かってもらえると思います。