/jr.mitou.org

未踏ジュニアの公式 Web サイトです。2020年2月1日リリース 🚀✨

Primary LanguageHTML

Test & Deploy

未踏ジュニア公式Webサイト

Cover Photo of Mitou Junior

本リポジトリは未踏ジュニア公式Webサイトの公開リポジトリです。
本READMEでは、公式Webサイトの更新方法を目的別にまとめています。


✅ （共通）ブラウザで情報修正を提案できます

どこを更新するにせよ Webブラウザが一番簡単 だと思います...!! 😆

  1. 下記の『更新方法』を参考に、修正を提案したい yml ファイルをクリックする
  2. 画面右にある ✎ アイコン (Fork this project and edit this file) をクリックする
  3. 気になる箇所を修正し、修正内容にタイトルと説明文を付け、Propose file change をクリックする
  4. 修正内容を確認し、問題なければ Create pull request をクリックする

以上で完了です。提案された修正内容は運営チームによって再確認され、問題なければ提案された内容が反映されます。もし修正内容に不具合があっても運営側で気付いて修正するので、まずはお気軽に提案してみてください 😉


📑 メディア掲載を更新したい

_data 内の media.yml にメディア掲載記事の情報があります。
上が新しい情報になるように記述するとよいでしょう。

それぞれの項目は以下のような内容です。

- title: 記事タイトル (例：「テクノロジー×好きなこと」で“未踏”の領域に挑む10代のトップクリエーターたち (こどもとIT))
  url: 記事ページのURL (例：https://www.watch.impress.co.jp/kodomo_it/news/1219499.html)
  date: 公開日 (例：2019/11/20)

🚀 プロジェクト情報を更新したい

_data 内の projects.yml にプロジェクトの情報があります。

それぞれの項目は以下のような内容です。

- id: 他のIDと重複しないID。例: utips
  title: プロジェクトのタイトル。例：UTIPS - 家事の情報共有サービス
  description: プロジェクト概要。例：家事のやり方を共有するWEBサービスを...
  thumbnail: サムネイル画像。まだ無い場合は「tbu.png」を入力
  youtube: YouTube動画。「?v=xxxx」の "xxxx" 部分。まだ無い場合は「TBD」を入力
  year: 採択プロジェクトの年度。例: 2018
  link: 公式サイトへのリンク（任意）。例: https://visi.dev/
  mentor_id: 「mentors.yml」にあるメンターIDを入力。例: yasulab
  creator_ids:
  - 「cretors.yml」にあるクリエータID。例：mihashi
  - 複数名いる場合は、複数記述します

👥 クリエータ情報を更新したい

_data 内の creators.yml にクリエーターの情報があります。

それぞれの項目は以下のような内容です。

- id: クリエータのID。例: mihashi
  project_id: 開発したプロジェクトのID。例: utips
  mentor_id: 担当メンターのID。例: yasulab`
  name: クリエータの名前。例: 三橋 優希
  is_spc: スーパークリエータ認定について。例：true
  year: 何年度に採択されたプロジェクトか。例: 2018

👤 メンター情報を更新したい

_data 内の mentors.yml にメンターの情報があります。

それぞれの項目は以下のような内容です。

- id: メンターの ID (例: yasulab)
  name:
    last: 名字。例：安川
    first: 名前。例: 要平
  img: `/assets/img/mentors/` に置いたプロフィール画像のファイル名。例: yasulab.png
  affiliation: 所属。例：YassLab 株式会社, 一般社団法人 CoderDojo Japan
  interested: こんな提案をお待ちしております。例：スクリプト言語やWebの特長を活かした…（略）
  bio: 略歴。aタグも使えるよ！例：<a href="https://yasslab.jp/">YassLab</a> 代表取締役…（略）
  facebook: Facebook ID。例：yasulab
  twitter: Twitter ID。例：yasulab
  github: GitHub ID。例：yasulab
  web: 上記以外のURL。例: https://yasslab.jp/

🛠️ Webサイトの仕組みを改善したい

ローカル環境のブラウザで確認したい場合は、次の手順でローカルサーバーを立ち上げてください。

# Ruby が入っていることを確認
$ ruby --version

# 必要なライブラリをインストール
$ bundle install

# ローカルサーバーを立ち上げる
$ bundle exec jekyll server

無事にローカルサーバーが立ち上がったら http://localhost:4000/ でアクセスできます。


📜 プロジェクト個別ページを生成したい

GitHub Actions で自動生成されるため毎回実行する必要はありませんが、新しい年度の採択プロジェクトの新規掲載時に手動で生成・確認したい場面などあれば、下記コマンドでプロジェクト個別ページを生成してください。

# _data/project.yml からプロジェクト個別ページを生成する
$ bundle exec rake upsert_project_pages_by_data

🤖 リンク切れはテストで検知できます

内部リンク (アンカー含む) や alt 属性の空欄などは次のコマンドでテストできます。

# ローカルサーバーの立ち上げは不要です
$ bundle exec rake test

テスト内容の詳細は Rakefile をご参照ください。

上記テストは GitHub Actions 上でも動いています。GitHub Actionsで動かしているタスクは .github/workflows ディレクトリから確認できます 👀 ✅


©️ クレジット

Copyright © 2016-2021 Mitou Foundation
未踏ジュニア運営チーム