dojocon2021.coderdojo.jp
DojoCon Japan 2021 公式サイト
本ページは DojoCon Japan 公式Webサイトの公開リポジトリです。
本READMEでは、公式Webサイトの更新方法を目的別にまとめています。
:white_check_mark: （共通）ブラウザで情報修正を提案できます
どこを更新するにせよ Webブラウザが一番簡単 だと思います...!! 😆
- 下記の『更新方法』を参考に、修正を提案したい yml ファイルをクリックする
- 画面右にある ✎ アイコン (Fork this project and edit this file) をクリックする
- 気になる箇所を修正し、修正内容にタイトルと説明文を付け、Propose file change をクリックする
- 修正内容を確認し、問題なければ Create pull request をクリックする
以上で完了です。提案された修正内容は運営チームによって再確認され、問題なければ提案された内容が反映されます。もし修正内容に不具合があっても運営側で気付いて修正するので、まずはお気軽に提案してみてください :wink:
:memo: Webサイトの更新方法
_data 内に ファイル名.yaml という YAML ファイルがあり、この YAML ファイルで Session 情報や Speaker 情報を更新できます。
それぞれの YAML ファイルの冒頭に次のようなコメントがあるので、
コメントを参考にして項目は以下のような内容です。
# - title: ワークショップタイトル（例: Dojo日本地図-日本全国のCoderDojoを探してみよう- ）
# stime: 開始時間。例: 10:00
# etime: 終了時間。例: 12:40
# tag: スペース区切りタグ。例: 忍者向け
# column: 列。0~2で指定。例:0
# url: URL。例: /session/dojo_report
追加・修正したい場所に応じて、下記リンク先を上記手順に沿って更新いただけます。
events.yml: イベント情報を更新したいmembers.yml: スタッフ情報を更新したいsessions.yml: セッション情報を更新したいsponsors.yml: スポンサー情報を更新したいworkshops.yml: ワークショップ情報を更新したい
:hammer_and_wrench: Webサイトを制作したい
ローカル環境でWebサイトを修正・確認したい場合は 以下のいずれかの方法 でローカルサーバーを立ち上げてください。
A. Docker 上で構築する方法（推奨）
# 下記コマンドでローカル環境にWebサーバーが立ち上がります
$ docker-compose up
無事にローカルサーバーが立ち上がったら、http://localhost:4000/ にアクセスしてWebサイトを修正・確認します。
B. Docker イメージをローカルで作成する方法
# Dockefile から dojocon-japan-2021 イメージを作成する
$ docker build -t dojocon-japan-2021 -f Dockerfile .
# 下記コマンドでローカル環境にWebサーバーが立ち上がります
$ docker-compose up
無事にローカルサーバーが立ち上がったら、http://localhost:4000/ にアクセスしてWebサイトを修正・確認します。
C. Ruby をインストールして構築する方法
# Ruby が入っていることを確認
$ ruby --version
# 必要なライブラリをインストール
$ bundle install
# ローカルサーバーを立ち上げる
$ bundle exec jekyll server
無事にローカルサーバーが立ち上がったら、http://localhost:4000/ にアクセスしてWebサイトを修正・確認します。
:robot: リンク切れはテストで検知できます
内部リンク (アンカー含む) や alt 属性の空欄などは次のコマンドでテストできます。
# ローカルサーバーの立ち上げは不要です
$ bundle exec rake test
テスト内容の詳細は Rakefile をご参照ください。
上記テストは GitHub Actions 上でも動いています。GitHub Actionsで動かしているタスクは .github/workflows ディレクトリから確認できます :eyes: :white_check_mark:
:octocat: 関連リポジトリ
- coderdojo-japan/dojocon2023.coderdojo.jp (TBD later)
- coderdojo-japan/dojocon2020.coderdojo.jp
- coderdojo-japan/dojocon2019.coderdojo.jp
- coderdojo-japan/dojocon2018.coderdojo.jp
♻️ License
Check out each license
This web application is developed with many other brilliant works!
Check out the followings if you are interested in. :wink:
📝️ Texts, Logos, and Photos
The texts and images, such as logos and photos of each staff, are owned by its content holder. Contact its owner, like the maintainer of linked external website or social account, before using them. 🔐
💎 Libraries and Codes
The libraries like RubyGems used in this website have their own licenses. Say, this website uses Jekyll, created by The Jekyll Team licensed under The MIT License. Thanks for their great works to make this website published! 💖
The source codes, such as HTML/CSS/JavaScript and Ruby codes not declared before, are published under The MIT License. Feel free to refer, copy, or share them. And contact us if you find something unclear.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
☯️️ Copyright
DojoCon Japan 実行委員会 & 一般社団法人 CoderDojo Japan (@coderdojo-japan).
