Merge pull request #13 from vrm-c/merge/site

Merge/site

blog/2024-01-12-blog-post.mdx

@@ -1,10 +1,19 @@
 ---
-title: sphinx to docusaurus
+title: サイトを更新しました
 authors: [vrmc]
 tags: [maintenance]
 ---
 
-# sphinx to docusaurus
+2024-01-15 からサイト更新作業をしています。
+
+:::info 不具合は
+
+https://github.com/vrm-c/vrm.dev/issues
+
+にお知らせください。
+:::
+
+## sphinx to docusaurus
 
 Document ツールを sphinx から docusaurus に変更しました。
 
@@ -16,3 +25,20 @@ https://github.com/vrm-c/vrm.dev/issues/315
 - sphinx figure(スクリーンショットなど)復旧
 - sphinx admonition(info, warning...)復旧
 
+## updated: 2024-01-16
+
+対応アプリケーションの一覧を更新しました。
+
+[showcase](/showcase)
+
+登録方法は **[こちら](/site/vrm_application)** です。
+PullReq じゃなくても issue で受け付けております。
+以前に登録済みの方の文言変更などもどうぞ。
+
+## updated: 2024-01-17
+
+- [記事更新](/site/contributing)
+- [翻訳](/site/translation)
+
+sphinx から docusaurus への変更に付随する作業はこれで完了の予定です。
+

blog/2024-01-17-english-url.md

@@ -0,0 +1,38 @@
+---
+title: 英語版のURLについて
+authors: [vrmc]
+tags: [maintenance]
+---
+
+2024-01-15 からサイト更新作業を実施しました。
+
+英語版の url 変更によりリンク切れが発生しました。
+url を維持するようにデプロイ方法を変更しました。
+現在、元の url でアクセスできるはずです。
+
+:::note vrm.dev.en
+
+英語版の記事を
+
+https://github.com/vrm-c/vrm.dev.en
+
+で管理して、
+
+https://vrm-c.github.io/vrm.dev.en/
+
+にデプロイしていましたが、
+デプロイ先を
+
+https://vrm.dev/en/
+
+に修正しました。
+
+:::
+
+:::info 不具合は
+
+https://github.com/vrm-c/vrm.dev/issues
+
+にお知らせください。
+:::
+

docs/site/build.md

@@ -0,0 +1,15 @@
+# ビルド
+
+github-action でビルドしています。 
+
+https://github.com/vrm-c/vrm.dev/blob/master/.github/workflows/docusaurus.yml
+
+- vrm.dev の master 更新でトリガーします
+- TODO: vrm.dev.en が更新された場合にトリガーする方法
+
+## build sequence
+
+- vrm.dev をビルド => `/build`
+- vrm.dev.en をビルド => `build/en`(master head)
+- gh-pages に `/build` を deploy
+

docs/site/contributing.md

@@ -0,0 +1,17 @@
+# 記事更新
+
+## vrm.dev への Pull Request の送りかた
+
+markdown 記事をこちらに pull request してください。
+
+https://github.com/vrm-c/vrm.dev/pulls
+
+## vrm.dev.en への Pull Request の送りかた
+
+markdown 記事の英訳をこちらに pull request してください。
+
+https://github.com/vrm-c/vrm.dev.en/pulls
+
+`vrm.dev` と `vrm.dev.en` のどちらか迷う場合は
+`vrm.dev` に送ってください。
+

docs/site/system.md

@@ -0,0 +1,37 @@
+# サイト構成
+
+## documents
+
+:::note sphinx の markdown を引き継ぎ
+
+先代の sphinx 、その前の hugo の markdown 記事をそのまま引き継いでいます。
+
+:::
+
+`/docs/**/*.md`
+
+## pages
+
+### `/`
+
+React
+
+`/src/pages/index.ts`
+
+### /showcase/
+
+VRM 対応アプリケーション
+
+React
+
+`/src/pages/showcase/index.tsx`
+`/src/data/tags.tsx`
+`/src/data/users.tsx`
+
+## customize
+
+言語切り替えメニューを改造しています。
+
+[Swizzling | Docusaurus](https://docusaurus.io/docs/swizzling)
+
+https://github.com/vrm-c/vrm.dev/blob/master/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.js

docs/site/translation.md

@@ -0,0 +1,81 @@
+# 翻訳
+
+言語ごとに 別の docusaurus リポジトリを個別に運営しています。
+日本語を原本として、英語版を fork しています。
+
+:::note sphinx の gettext 方式を fork 方式に変更しました
+
+参考 [オープンソースドキュメント翻訳プラットフォームとしての GitHub (React 日本語ドキュメントの例)](https://zenn.dev/smikitky/articles/0d250f7367eda9)
+
+:::
+
+## 日本語
+
+https://github.com/vrm-c/vrm.dev
+
+日本語を原本サイトとして https://vrm.dev にデプロイします。
+
+## 英語
+
+https://github.com/vrm-c/vrm.dev.en
+
+英語版を https://vrm.dev/en にデプロイします。
+
+:::note github-action でまとめてビルド
+
+日本語サイトをビルド時に
+`/en` ディレクトリにビルドしています。
+
+:::
+
+## 翻訳手順
+
+- vrm.dev の内容が更新される
+- vrm.dev の更新を vrm.dev.en に反映する(fetch merge して push する)。この作業は、`vrm.dev` の管理者が定期的(毎週？)に実行します
+  - 未訳部分が増えます
+  - conflict する場合があるが、docusaurus のビルドが通る場合は そのまま commit してよい。TODO: 自動化
+- vrm.dev.en に未訳部分を英訳したり、英文の更新 PullReq を送る
+
+## 作業例(github の website 上)
+
+TODO: markdown ひとつだけならこれでもできるはず。
+
+## 作業例(ローカル)
+
+### preview を起動
+
+```sh
+$ git clone https://github.com/vrm-c/vrm.dev.en.git
+$ git switch -c fix/EN_TOPIC # 適当な重複しない branch 名をつけてください
+$ cd vrm.dev.en
+$ npm install
+$ npm run dev
+
+# https://localhost:3000 にアクセス。翻訳記事を見る。
+```
+
+### エディターで翻訳
+
+push して `pull request`
+
+## 作業例(管理者向け。日本語への追随)
+
+TODO: bot で自動化
+
+```sh
+$ git clone https://github.com/vrm-c/vrm.dev.en.git
+$ cd vrm.dev.en
+$ git remote add ja https://github.com/vrm-c/vrm.dev
+
+$ git switch -c merge/topic
+$ git fetch ja master
+$ git merge ja master
+$ npm run build
+
+# エラーがある場合は conflict を解決してビルドを通す。
+# build が透る場合は merge を commit して先に進めてよい。
+
+$ git commit
+$ git push
+```
+

docs/site/vrm_application.md

@@ -0,0 +1,41 @@
+# 対応Applicationの登録
+
+以下の内容で [こちら](https://github.com/vrm-c/vrm.dev/issues) に `issue` で依頼をしてください。
+`PullRequest` にしなくても大丈夫です。
+内容がわかれば、JSON でなくても受け付けております。
+英語が省略された場合は、日本語をコピーします。
+
+```js
+{
+  tag: 'CharacterPlatform', // 分類。空欄であればこちらで判断します
+  ja: { // 日本語
+    title: 'ザ・シードオンライン',
+    url: 'https://virtualcast.jp/store/',
+    description: '`1.0` アップロード可。3D viewer は `1.0` 未対応', // markdown可能
+  },
+  en: { // english information
+    title: 'The Seed Online',
+    url: 'https://virtualcast.jp/store/',
+    description: '`1.0` can be uploaded. 3D viewer does not support `1.0`', // markdown可能
+  },
+  vrm: '1.0', // vrm-1.0 の対応状況. '', '1.0', '0.x only', '1.0 only'
+  // showcase の VRM カラムです
+}
+```
+
+:::note tag の一覧
+- CharacterPlatform
+- CharacterCreation
+- ImporterExporter
+- Streaming
+- MotionCapture
+- Animation
+- Photography
+- Metaverse
+- Game
+- WebBrowser
+- Viewer
+- UsingInternally
+- Other
+:::
+

docusaurus.config.ts

@@ -96,6 +96,12 @@ const config: Config = {
         { to: '/tags', label: 'Tags', position: 'left' },
         { to: '/blog', label: 'Blog', position: 'left' },
         //
+        {
+          label: 'Site',
+          type: 'docSidebar',
+          sidebarId: 'siteSidebar',
+          position: 'right',
+        },
         {
           label: 'UniHumanoid',
           type: 'docSidebar',

sidebars.ts

@@ -188,7 +188,18 @@ const sidebars: SidebarsConfig = {
     ],
   }],
 
-
+  siteSidebar: [{
+    type: 'category',
+    label: 'サイト管理',
+    // link: { type: 'doc', id: 'site/index' },
+    items: [
+      { type: 'doc', id: 'site/system' },
+      { type: 'doc', id: 'site/build' },
+      { type: 'doc', id: 'site/vrm_application' },
+      { type: 'doc', id: 'site/contributing' },
+      { type: 'doc', id: 'site/translation' },
+    ],
+  }],
   unihumanoidSidebar: [{ type: 'autogenerated', dirName: 'unihumanoid' }],
   apiSidebar: [{
     type: 'category',