| Time (UTC) | Icon | Name | Message |
|---|---|---|---|
| 02:33 |  |
shinyu | Vivliostyle Viewer の README ファイルは、以前は vivliostyle-ui リポジトリのルートにあるものと dist ディレクトリにあるもの（zipパッケージに同梱される）との２種類ありました： https://github.com/vivliostyle/vivliostyle-ui/blob/2019.8.101/README.md https://github.com/vivliostyle/vivliostyle-ui/blob/2019.8.101/dist/README.md https://github.com/vivliostyle/vivliostyle-ui/blob/2019.8.101/dist/README.ja.md v2.0 でも、npm 上の @vivliostyle/viewer のドキュメントとなる README ファイルと zip パッケージの README は別のものが必要なのではないかと思います。 それぞれのパッケージでの次の説明が必要です。 • 自分のサイトに viewer を設置する方法 • ローカル環境で viewer を利用する方法 |
| 02:33 |  |
Kiara Translation | 🇬🇧: There were two types of Vivliostyle Viewer README files, one at the root of the vivliostyle-ui repository and one in the dist directory (included in the zip package): https://github.com/vivliostyle/vivliostyle-ui/blob/2019.8.101/README.md https://github.com/vivliostyle/vivliostyle-ui/blob/2019.8.101/dist/README.md https://github.com/vivliostyle/vivliostyle-ui/blob/2019.8.101/dist/README.en.md Even in v2.0, I think that the README file that is the document of @ vivliostyle / viewer on npm and the README of the zip package need to be different. The following explanation is required for each package. • How to install viewer on your site • Using viewer in a local environment |
| 02:41 |  |
uetchy | むしろ両方含めて良いと思います |
| 02:41 | |
Kiara Translation | 🇬🇧: I would rather include both. |
| 02:47 | |
shinyu | ひとつのREADMEファイルの中に、npm版の場合とzip版の場合との両方の説明を含めるということですか？ |
| 02:47 | |
Kiara Translation | 🇬🇧: Does that mean that both the npm version and the zip version are included in one README file? |
| 02:53 | |
uetchy | ファイルを分けるか統合するかは任意ですが、二つの間にはファイルの置き場所以外違いがないので分離する必要はないと思います。 |
| 02:53 | |
Kiara Translation | 🇬🇧: Separating or merging the files is optional, but there is no difference between the two except for the location of the files, so I don't think it is necessary to separate them. |
| 02:53 | |
uetchy | 統合してCIビルド時にコピーした方が片方の更新忘れみたいなミスを防げるので良いですね |
| 02:53 | |
Kiara Translation | 🇬🇧: It's better to merge and copy to prevent mistakes like forgetting to update one. |
| 03:24 | |
shinyu | Vivliostyle Viewer のzipパッケージ版に入っている start-webserver スクリプト、以前は次のものでした: https://github.com/vivliostyle/vivliostyle-ui/blob/2019.1.106/scripts/start-webserver https://github.com/vivliostyle/vivliostyle-ui/blob/2019.1.106/scripts/start-webserver.bat まず npm がインストールされているかどうかチェックして、それがあれば npm の http-server をインストールして実行するというものでした。 しかしこれを何人かにも実行してもらったところ、npm のエラーなどに遭遇して、インストールできない人がとても多いことが分かりました。 （エラーの原因は、カレントディレクトリを start-webserver があるところに移動しないで実行することなど） そこで、ユーザーの環境に入っていることが多い ruby でのウェブサーバーを優先するように、次のコミットで直しました: https://github.com/vivliostyle/vivliostyle-ui/commit/cc74188cf5b6ab75d7c39553d00f23cc9a7fe9f1 またこのとき、ローカルのファイルをオンラインの Vivliostyle Viewer でも表示確認できるように、CORSを有効にするようにしてみました。（これはあまり必要ないかもしれません） 今回npm版の @vivliostyle/viewer ができたので、npm版とzip版とで使い方をなるべく共通化できるように、この start-webserver についても再検討したいところです。 |
| 03:24 | |
Kiara Translation | 🇬🇧: The start-webserver script in the zip package version of Vivliostyle Viewer, formerly: https://github.com/vivliostyle/vivliostyle-ui/blob/2019.1.106/scripts/start-webserver https://github.com/vivliostyle/vivliostyle-ui/blob/2019.1.106/scripts/start-webserver.bat The first thing was to check if npm was installed, and if so, install and run npm's http-server. However, after several people did this, they found that there were a lot of people who couldn't install because they encountered npm errors. (The cause of the error is to execute the current directory without moving to the place where start-webserver is located) So we fixed it with the following commit to give preference to the ruby web server that is often in the user's environment: https://github.com/vivliostyle/vivliostyle-ui/commit/cc74188cf5b6ab75d7c39553d00f23cc9a7fe9f1 Also, at this time, I tried to enable CORS so that local files can be displayed in the online Vivliostyle Viewer. (This may not be necessary) Now that the npm version of @ vivliostyle / viewer has been created, I would like to reconsider this start-webserver so that the npm version and the zip version can be used as much as possible. |
| 03:38 | |
shinyu | 二つの間にはファイルの置き場所以外違いがないnpmでインストールされる /node_modules/@vivliostyle/viewer/lib/ とzipパッケージの中の /vivliostyle/viewer/ が同じものということですね？ |
| 03:38 | |
Kiara Translation | 🇬🇧: & gt; There is no difference between the two except the location of the file Installed with npm / node_modules / @ vivliostyle / viewer / lib / And in the zip package / vivliostyle / viewer / Is that the same thing? |
| 04:20 | |
uetchy | @shinyu そうです！オンラインドキュメントの上部にトグルスイッチを用意して、自動推論に加えてさらに手動でローカルとオンライン版のドキュメントを切り替える（URLをjsで変える）ことができるようにする案を考えています。どう思いますか？ また、現状のドキュメントをorgの/docs/2019.XXX/にバージョン付けして配置することで、zipにドキュメントを同梱しないで済む方法も検討中です。あわせてREADMEのセットアップ手順もドキュメントに統合して、色んな場所にリンクを飛ばさないようにします。この結果、ドキュメント系のリンクをドキュメント環境に閉じることができます。 |
| 04:20 | |
Kiara Translation | 🇬🇧: That's right! The idea is to provide a toggle switch at the top of the online document so that in addition to automatic inference, you can manually switch between local and online documents. What do you think? In addition, we are considering a method that eliminates the need to include the document in the zip by placing the current document in the version of /docs/2019.XXX/ in org. At the same time, the README setup procedure is also integrated into the document so that links are not skipped in various places. As a result, document links can be closed to the document environment. |
| 04:20 | |
Kiara Translation | 🇬🇧: That's right! The idea is to provide a toggle switch at the top of the online document so that in addition to automatic inference, you can manually switch between local and online documents. What do you think? In addition, we are considering a method that eliminates the need to include the document in the zip by placing the current document in the version of /docs/2019.XXX/ in org. At the same time, the README setup procedure is also integrated into the document so that links are not skipped in various places. As a result, document links can be closed to the document environment. |
| 05:19 | |
uetchy | https://docusaurus.io/en/versions Docusaurusはデフォルトでバージョニングされたドキュメントの生成に対応しているようです Easy to Maintain Open Source Documentation Websites |
| 05:19 | |
Kiara Translation | 🇬🇧: https://docusaurus.io/en/versions Docusaurus seems to support generation of versioned documents by default |