クイックスタートガイド(機能紹介)を作成した #6

h-takeyeah · 2021-03-28T13:39:10Z

前回，室員向けの内容が混在したものを作成してしまったので，掲載する情報を研究室に紹介するときに使えそうな内容に絞った．textlintはかけてある．

manual/quick-start-guide.md

ghost · 2021-03-29T17:42:18Z

@h-takeyeah もうpushしたものなので変更しようもないし、別にトレーサビリティは確保されていますが、
取り込みその1～4ってのは、こみっとコミットメッセージとして分かりにくいのではないかと思いました。
(個人の感想です)

equal-l2 · 2021-03-29T17:50:24Z

こういう文法上の瑣末な修正はツリーに入られても困るので、interactive rebaseで元のコミットとまとめて一つのコミットにしてもいいかもしれません。
(developやmainにどのくらいの粒度のコミットが入るのを許すかは流儀の問題なので一概には言えませんが)

ghost · 2021-03-30T07:45:37Z

こういう文法上の瑣末な修正はツリーに入られても困るので、interactive rebaseで元のコミットとまとめて一つのコミットにしてもいいかもしれません。
(developやmainにどのくらいの粒度のコミットが入るのを許すかは流儀の問題なので一概には言えませんが)

慌てていて手元でCIを回す時間もない、あるいはRedpenのようにdocker化されてないと、ちゃんと動かない(特にwinだと)場合まで考えると、pushして確認してもらったほうが楽、というインセンティブが生まれてしまうのは仕方のない事かもしれません。これについては私がDocker環境をちゃんと構築してCONTRIBUTING.mdを策定していなかったのが悪い、と言われたら反論は致しません。
(かといって責任を取れる状況ではありませんが)

ghost · 2021-03-30T07:53:51Z

@h-takeyeah
外野がヤジを投げているようで大変恐縮ではございますが、このqsgが個人的なメモなのか、喋ることを予め用意してあるのか、等考えたのですが、これが何を為したいのかが私には分かりません。

もちろん、制作者サイドである我々は8割ないし9割の機能は分かるでしょうが、それがまるでこれから導入する教授にもコモンセンスであるかの如く書かれているような気がしてなりません。

もちろん、そういう意図はないでしょうが、もっと具体的な機能説明が必要だと思います。

クイックスタートガイド、という名目上関係ないんだ、と言われたら何も言えないのですが、最も重要な「瑕疵」及び「責任範囲」の明確化、トラブル時のエスカレーション、そういったものが全てありません。

拙いですが、私はとりあえず、メモ書き程度ではございますが、readmeに記載しておきました。

で、結局ドキュメントとして提出すべきもの、確認すべきこと、了承してもらうこと、最低でもこれくらいは誰の目(これだとフレームが大きいので静大生の情報学部の教授クラスまで限定したとして)からも明らかでないと、責任問題から、貴方たち、ひいてはITSが逃れることが出来ないのではないのか、と老婆心ながら具申いたします。

equal-l2 · 2021-03-30T12:10:16Z

manual/quick-start-guide.md

+  2. `localhost:3001`にアクセスします。
+- ラズパイにディスプレイを接続せずに使う場合
+  1. ラズパイと同じネットワークに接続した任意の PC でブラウザを起動します。
+     - ラズパイを学内 LAN に接続した場合は PC も学内 LAN (WRL-SUCCES-S3) に接続します。


ラズパイを学内LANに繋ぐとどこからでも全ての情報が見えて全ての操作ができてしまうので、設置する側としては強くdiscourageしたいところであります。

今って室の状況が学内に公開されてる状況ってことですよね？
とするとアドレスを知らないと見ることができないとはいえ，既にdiscourageされるべき運用をしちゃってるってことですよね．

技術的にどう対策するかという話をすると

バックエンド: listenするホストをNuxt(localhost)のみに限定する

フロントエンド: Basic認証等の認証系ミドルウェアを噛ませることで研究室の人間以外に使わせない

という方法になると思います．バックエンドは自分がすぐできます．フロントの方も調べればなんとかできると思います．

結局導入先がどのくらいのプライバシー意識を持ってるかによるんですよね。
ITSでは「別に知らん人が勝手に入室してもいいし、誰に何を見られてもいい」くらいなので現状でいいんですが、みんながみんなそうではないと思うので。
現状のまま行くなら「学内LANに繋ぐとどっからでもなんでもできちゃいますよ」という†免責†は必要だと思います。

プロクシしてるからフロントで認証しちゃえばそれで終わりっていうのもそれはそうですね。
認証はNuxtに@nuxtjs/auth-nextというのがあるので、やるとなったらそれを使うとよさそうです。

equal-l2 · 2021-03-31T06:37:32Z

manual/quick-start-guide.md

+
+画面上部分では、現在までの入退室ログ(学籍番号、入室時間、退室時間)が CSV 形式でダウンロードできます。
+
+デフォルトでは直近 3 ヵ月分ですが、 **[ 自分で設定する ]** ボタンを押して任意の期間を設定してのダウンロードもできます。


「ラズパイの入退室記録は定期的にバックアップを取って欲しい」旨のことをどこかに書いておいて欲しいです
(ここではない気がするけど……)

github-actions · 2021-04-02T04:02:32Z

readme.adoc


 WARNING: 本業の学業を疎かにしてまで、システム改修をすることは出来ませんので、仕様変更等については一切お受けしかねます。

-ただし、本プログラムについてはGitHubにてリポジトリを公開しており、またMITライセンスにしているため、改変等に関しては禁止しておりません。
+ただし、本プログラムについては GitHub にてリポジトリを公開しており、また MIT ライセンスにしているため、改変等に関しては禁止しておりません。

 CAUTION: MITライセンスの規約を守って頂けることを前提にしていますので、それは必ず守ってください。


🚫 [redpen] _{reported by reviewdog 🐶}
Space not present after an alphabetical word.

github-actions · 2021-04-02T04:02:32Z

readme.adoc


 CAUTION: MITライセンスの規約を守って頂けることを前提にしていますので、それは必ず守ってください。

 ---

 ### 確認事項

-. DB等への改造を施した場合、ITSでは補償対象外になります。(リカバリ手順書に記載されている場合を除く)
+. DB 等への改造を施した場合、ITS では補償対象外になります。(リカバリ手順書に記載されている場合を除く)


🚫 [redpen] _{reported by reviewdog 🐶}
Parenthesized sentence is too long.

github-actions · 2021-04-02T04:02:32Z

readme.adoc


 CAUTION: MITライセンスの規約を守って頂けることを前提にしていますので、それは必ず守ってください。

 ---

 ### 確認事項

-. DB等への改造を施した場合、ITSでは補償対象外になります。(リカバリ手順書に記載されている場合を除く)
+. DB 等への改造を施した場合、ITS では補償対象外になります。(リカバリ手順書に記載されている場合を除く)
 . 仕様変更は一切対応しません。学業を疎かにして、所属もしてない研究室に尽くすほど、お人よしではありません。


🚫 [redpen] _{reported by reviewdog 🐶}
Found invalid expression "してない".

github-actions · 2021-04-02T04:02:32Z

readme.adoc

-. 本システムへの改修、改良はMITライセンスでの範囲内なら自由にして頂いて構いませんが、ITSの補償から外れます。この点は必ずご了承ください。
-. ITS(の本システムの開発メンバ)に瑕疵が存在するのは、ローンチしたモノが(電源コードが外れてしまったも異常動作に含みます)正常に動作しているにも関わらず、意図しない動作をした場合に限ります。
+. 本システムへの改修、改良は MIT ライセンスでの範囲内なら自由にしていただいてかまいませんが、ITS の補償から外れます。この点は必ずご了承ください。
+. ITS(の本システムの開発メンバー)に瑕疵が存在するのは、ローンチしたモノが正常に動作しているにもかかわらず、意図しない動作をした場合に限ります。
 . また、基本的には極めて緊急の場合を除き、遊橋先生経由で修復依頼はお願いします。


🚫 [redpen] _{reported by reviewdog 🐶}
Found too long kanji chain: "遊橋先生経由" (6.)

github-actions · 2021-04-02T04:02:32Z

readme.adoc

🚫 [redpen] _{reported by reviewdog 🐶}
Parenthesized sentence is too long.

github-actions · 2021-04-02T04:02:33Z

manual/quick-start-guide.md

+
+研究室への出入り時、カードリーダーに本学の学生証や職員証をタッチすることで入室時刻または退室時刻がデータベースに記録されます。
+
+### 学生側利用時の流れ


🚫 [redpen] _{reported by reviewdog 🐶}
Found too long kanji chain: "学生側利用時" (6.)

細かい修正とユーザインターフェースの説明の部分への導入を追加した

Update quick-start-guide.md

github-actions · 2021-04-02T05:36:25Z

manual/quick-start-guide.md

+
+- ラズベリーパイにディスプレイやキーボードを接続して使う場合
+  1. ラズパイで画面左上の:earth_americas:マークをクリックしブラウザを起動します。
+  2. ブラウザで`http://localhost:3001`にアクセスします。


🚫 [textlint] <eslint.rules.ja-spacing/ja-space-around-code> _{reported by reviewdog 🐶}
インラインコードの前にスペースを入れてください。 (ja-spacing/ja-space-around-code)

github-actions · 2021-04-02T05:36:25Z

manual/quick-start-guide.md

+
+- ラズベリーパイにディスプレイやキーボードを接続して使う場合
+  1. ラズパイで画面左上の:earth_americas:マークをクリックしブラウザを起動します。
+  2. ブラウザで`http://localhost:3001`にアクセスします。


🚫 [textlint] <eslint.rules.ja-spacing/ja-space-around-code> _{reported by reviewdog 🐶}
インラインコードの後にスペースを入れてください。 (ja-spacing/ja-space-around-code)

github-actions · 2021-04-02T05:36:26Z

manual/quick-start-guide.md

+- ラズベリーパイにディスプレイを接続せずに使う場合
+  1. ラズベリーパイと同じネットワークに接続した任意の PC でブラウザを起動します。
+     - ラズベリーパイを学内 LAN に接続した場合は PC も学内 LAN (WRL-SUCCES-S3) に接続します。
+  2. ブラウザで`http://<ラズベリーパイの IP>:3001`にアクセスします。


🚫 [textlint] <eslint.rules.ja-spacing/ja-space-around-code> _{reported by reviewdog 🐶}
インラインコードの前にスペースを入れてください。 (ja-spacing/ja-space-around-code)

github-actions · 2021-04-02T05:36:26Z

manual/quick-start-guide.md

+- ラズベリーパイにディスプレイを接続せずに使う場合
+  1. ラズベリーパイと同じネットワークに接続した任意の PC でブラウザを起動します。
+     - ラズベリーパイを学内 LAN に接続した場合は PC も学内 LAN (WRL-SUCCES-S3) に接続します。
+  2. ブラウザで`http://<ラズベリーパイの IP>:3001`にアクセスします。


🚫 [textlint] <eslint.rules.ja-spacing/ja-space-around-code> _{reported by reviewdog 🐶}
インラインコードの後にスペースを入れてください。 (ja-spacing/ja-space-around-code)

github-actions · 2021-04-02T05:36:26Z

manual/quick-start-guide.md

+  2. ブラウザで`http://<ラズベリーパイの IP>:3001`にアクセスします。
+
+---
+### ユーザインターフェースのメニューについて


🚫 [textlint] <eslint.rules.prh> _{reported by reviewdog 🐶}
ユーザイ => ユーザーイ (prh)

github-actions · 2021-04-02T05:36:26Z

manual/quick-start-guide.md

+  2. ブラウザで`http://<ラズベリーパイの IP>:3001`にアクセスします。
+
+---
+### ユーザインターフェースのメニューについて


🚫 [textlint] <eslint.rules.spellcheck-tech-word> _{reported by reviewdog 🐶}
インターフェース => インタフェース (spellcheck-tech-word)

github-actions · 2021-04-02T05:36:26Z

manual/quick-start-guide.md

+---
+### ユーザインターフェースのメニューについて
+
+ユーザインターフェースの各メニューについての説明を以下に示します．


🚫 [textlint] <eslint.rules.prh> _{reported by reviewdog 🐶}
ユーザイ => ユーザーイ (prh)

github-actions · 2021-04-02T05:36:26Z

manual/quick-start-guide.md

+---
+### ユーザインターフェースのメニューについて
+
+ユーザインターフェースの各メニューについての説明を以下に示します．


🚫 [textlint] <eslint.rules.spellcheck-tech-word> _{reported by reviewdog 🐶}
インターフェース => インタフェース (spellcheck-tech-word)

github-actions · 2021-04-02T05:36:26Z

manual/quick-start-guide.md

+---
+### ユーザインターフェースのメニューについて
+
+ユーザインターフェースの各メニューについての説明を以下に示します．


🚫 [textlint] <eslint.rules.ja-technical-writing/ja-no-mixed-period> _{reported by reviewdog 🐶}
文末が"。"で終わっていません。 (ja-technical-writing/ja-no-mixed-period)

github-actions · 2021-04-02T05:36:32Z

manual/quick-start-guide.md

+
+- ラズベリーパイにディスプレイやキーボードを接続して使う場合
+  1. ラズパイで画面左上の:earth_americas:マークをクリックしブラウザを起動します。
+  2. ブラウザで`http://localhost:3001`にアクセスします。


[textlint-fix] _{reported by reviewdog 🐶}

Suggested change

2. ブラウザで`http://localhost:3001`にアクセスします。

2. ブラウザで `http://localhost:3001` にアクセスします。

github-actions · 2021-04-02T05:36:32Z

manual/quick-start-guide.md

+- ラズベリーパイにディスプレイを接続せずに使う場合
+  1. ラズベリーパイと同じネットワークに接続した任意の PC でブラウザを起動します。
+     - ラズベリーパイを学内 LAN に接続した場合は PC も学内 LAN (WRL-SUCCES-S3) に接続します。
+  2. ブラウザで`http://<ラズベリーパイの IP>:3001`にアクセスします。


[textlint-fix] _{reported by reviewdog 🐶}

Suggested change

2. ブラウザで`http://<ラズベリーパイの IP>:3001`にアクセスします。

2. ブラウザで `http://<ラズベリーパイの IP>:3001` にアクセスします。

github-actions · 2021-04-02T05:36:32Z

manual/quick-start-guide.md

+  2. ブラウザで`http://<ラズベリーパイの IP>:3001`にアクセスします。
+
+---
+### ユーザインターフェースのメニューについて


[textlint-fix] _{reported by reviewdog 🐶}

Suggested change

### ユーザインターフェースのメニューについて

### ユーザーインタフェースのメニューについて

github-actions · 2021-04-02T05:36:32Z

manual/quick-start-guide.md

+---
+### ユーザインターフェースのメニューについて
+
+ユーザインターフェースの各メニューについての説明を以下に示します．


[textlint-fix] _{reported by reviewdog 🐶}

Suggested change

ユーザインターフェースの各メニューについての説明を以下に示します．

ユーザーインタフェースの各メニューについての説明を以下に示します．

github-actions · 2021-04-02T05:36:37Z

manual/quick-start-guide.md

+
+- ラズベリーパイにディスプレイやキーボードを接続して使う場合
+  1. ラズパイで画面左上の:earth_americas:マークをクリックしブラウザを起動します。
+  2. ブラウザで`http://localhost:3001`にアクセスします。


🚫 [redpen] _{reported by reviewdog 🐶}
Space not present before an alphabetical word.

github-actions · 2021-04-02T05:36:37Z

manual/quick-start-guide.md

+- ラズベリーパイにディスプレイを接続せずに使う場合
+  1. ラズベリーパイと同じネットワークに接続した任意の PC でブラウザを起動します。
+     - ラズベリーパイを学内 LAN に接続した場合は PC も学内 LAN (WRL-SUCCES-S3) に接続します。
+  2. ブラウザで`http://<ラズベリーパイの IP>:3001`にアクセスします。


🚫 [redpen] _{reported by reviewdog 🐶}
Space not present before an alphabetical word.

github-actions · 2021-04-02T05:36:37Z

manual/quick-start-guide.md

+---
+### ユーザインターフェースのメニューについて
+
+ユーザインターフェースの各メニューについての説明を以下に示します．


🚫 [redpen] _{reported by reviewdog 🐶}
Found a Katakana word "ユーザインターフェース", which is similar to "ユーザーインタフェース" at position 18.

github-actions · 2021-04-02T05:36:38Z

manual/quick-start-guide.md

+  2. ブラウザで`http://<ラズベリーパイの IP>:3001`にアクセスします。
+
+---
+### ユーザインターフェースのメニューについて


🚫 [redpen] _{reported by reviewdog 🐶}
Found a Katakana word "ユーザインターフェース", which is similar to "ユーザーインタフェース" at position 18.

h-takeyeah added 2 commits March 26, 2021 12:57

quick-start-guide.mdを試作

a353814

初期設定のくだりを削除

666fb68

h-takeyeah requested a review from equal-l2 March 28, 2021 13:39

github-actions bot reviewed Mar 28, 2021

View reviewed changes

reviewdogの指摘取り込み

a028472

github-actions bot reviewed Mar 28, 2021

View reviewed changes

manual/quick-start-guide.md Outdated Show resolved Hide resolved

manual/quick-start-guide.md Outdated Show resolved Hide resolved

reviewdogの指摘取り込みその2

3330079

h-takeyeah force-pushed the qsg branch from 91aa91d to 3330079 Compare March 28, 2021 14:23

h-takeyeah added 3 commits March 28, 2021 23:26

reviewdogの指摘取り込みその3

f5c752a

reviewdogの指摘取り込みその4

3f44b76

reviewdogの指摘取り込みその5

e8e464f

h-takeyeah force-pushed the qsg branch from e941f5c to e8e464f Compare March 28, 2021 14:37

equal-l2 reviewed Mar 30, 2021

View reviewed changes

equal-l2 reviewed Mar 31, 2021

View reviewed changes

qsgへの添削した

06fb7bd

github-actions bot reviewed Apr 2, 2021

View reviewed changes

GGBBB2000 and others added 2 commits April 2, 2021 13:36

Update quick-start-guide.md

f08a141

細かい修正とユーザインターフェースの説明の部分への導入を追加した

Merge pull request #12 from GGBBB2000/patch-2

58e4e86

Update quick-start-guide.md

github-actions bot reviewed Apr 2, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

クイックスタートガイド(機能紹介)を作成した #6

クイックスタートガイド(機能紹介)を作成した #6

h-takeyeah commented Mar 28, 2021

ghost commented Mar 29, 2021

equal-l2 commented Mar 29, 2021

ghost commented Mar 30, 2021

ghost commented Mar 30, 2021

equal-l2 Mar 30, 2021

h-takeyeah Mar 30, 2021 •

edited by equal-l2

Loading

equal-l2 Mar 30, 2021

equal-l2 Mar 31, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021

github-actions bot Apr 2, 2021


		画面上部分では、現在までの入退室ログ(学籍番号、入室時間、退室時間)が CSV 形式でダウンロードできます。

		デフォルトでは直近 3 ヵ月分ですが、 [ 自分で設定する ] ボタンを押して任意の期間を設定してのダウンロードもできます。


		研究室への出入り時、カードリーダーに本学の学生証や職員証をタッチすることで入室時刻または退室時刻がデータベースに記録されます。

		### 学生側利用時の流れ

	2. ブラウザで`http://localhost:3001`にアクセスします。
	2. ブラウザで `http://localhost:3001` にアクセスします。

	2. ブラウザで`http://<ラズベリーパイの IP>:3001`にアクセスします。
	2. ブラウザで `http://<ラズベリーパイの IP>:3001` にアクセスします。

	### ユーザインターフェースのメニューについて
	### ユーザーインタフェースのメニューについて

	ユーザインターフェースの各メニューについての説明を以下に示します．
	ユーザーインタフェースの各メニューについての説明を以下に示します．

クイックスタートガイド(機能紹介)を作成した #6

Are you sure you want to change the base?

クイックスタートガイド(機能紹介)を作成した #6

Conversation

h-takeyeah commented Mar 28, 2021

ghost commented Mar 29, 2021

equal-l2 commented Mar 29, 2021

ghost commented Mar 30, 2021

ghost commented Mar 30, 2021

equal-l2 Mar 30, 2021

Choose a reason for hiding this comment

h-takeyeah Mar 30, 2021 • edited by equal-l2 Loading

Choose a reason for hiding this comment

equal-l2 Mar 30, 2021

Choose a reason for hiding this comment

equal-l2 Mar 31, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

github-actions bot Apr 2, 2021

Choose a reason for hiding this comment

h-takeyeah Mar 30, 2021 •

edited by equal-l2

Loading