W3C Web of Things Japanese Community Group (W3C WoT-JP CG)

• このリポジトリは W3C Web of Things Japanese Community Group (W3C WoT-JP CG) のリポジトリであり、W3C WoT-JP CG の活動に関するドキュメントやコードを格納しています。
• WoT-JP CG 及び本リポジトリでは、主要な言語として日本語を使用します。
• 本リポジトリは世界中に公開されており、自由に閲覧いただけます。なお、一般公開されておりますので，情報発信にあたっては十分にご注意ください。
• GitHub の Pull Request 作成等、本リポジトリに対してのご貢献をいただく際には、W3C WoT-JP CGに参加登録した上で利用いただけますと幸いです。
• 本リポジトリへの質問や提案については、GitHubのIssues を利用してください。
• 本リポジトリ内のコンテンツの具体的な変更については、GitHubのPull Request を利用してください。

W3C WoT-JP CG のリポジトリ利用にあたっての基本方針

W3C WoT-JP CG では下記の基本方針に注意の上、ご利用ください。

• CG チャーター
• 本リポジトリへの貢献について
• 本リポジトリのライセンス
• 本リポジトリの行動規範
• WoT-JP CG 活動の提案・合意プロセス

W3C WoT-JP CG サイトとコンテンツ管理方法

• 構成

  • W3C WoT-JP サイトのコンテンツは本リポジトリの docs サブディレクトリ配下に格納しています。
  • docsify によるシンプルなサイトです。
    • index.html 単独動作、Markdown ファイル xxxxx.md に書いた記事を URL フラグメントで /#/xxxxx として読み込む構成
    • コンテンツは全て普通の Markdown なので任意のモダンなフレームワークによるサイトにいつでも変換可能

• コンテンツの追加・更新

  • Issues を立てて議論したり Pull Requestsを作成 してください。提案・合意プロセスに記載の通り、コメント欄などを通じてコミュニティ内でのコンセンサスを得たうえで、モデレータが main ブランチにマージします。
  • Markdown フォーマットで書かれたファイルは docsify が HTML へ変換します。HTML で書かれたファイルも利用可能ですが、その場合は Markdown として解釈されることを防ぐために、Markdown ファイルから HTML ファイルへのリンクに":ignore"を追加してください(詳細: Ignore to compile link)。

• デプロイ

  

  • Netlify でホスティングしています。
  • 現状ほぼ単なる静的ホスティング (と画像の自動圧縮など自動最適化) だけなのでデプロイに失敗することはほぼないと思いますが、最新のデプロイ結果は上記の Netlify Status バッジ を参考にしてください。黄色や赤になっている場合はデプロイログを参照して原因を確認してください。

• ドキュメント
  • Netlify のヘルプ
  • Docsify の Netlify デプロイ