Skip to content

Latest commit

 

History

History
204 lines (140 loc) · 13.6 KB

README.md

File metadata and controls

204 lines (140 loc) · 13.6 KB
Raw

Test & Deploy

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

Cover Photo of Mitou Junior

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


✅ ブラウザで情報を更新できます（共通）

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

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

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


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

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

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

- id: 他のIDと重複しないID。例: visible
  title: プロジェクトのタイトル。例：Visible ─ Webアクセシビリティー診断 & 修正提案ツール
  description: プロジェクト概要。例：VisibleはWebサイトのアクセシビリティーを診断するサービスです。...
  thumbnail: サムネイル画像。まだ無い場合はコメントアウトしてください。
  promotion: プロジェクトの PV やデモ動画。YouTubeの「?v=xxx」の "xxx" 部分。無い場合はコメントアウト。(Gif にも対応)
  final: 未踏ジュニア成果報告会の発表動画。YouTubeの「?v=xxx」の "xxx" 部分。無い場合はコメントアウト。
  final_start: （任意）final の動画再生の開始時刻を指定できます。成果報告会の直後で使います。(例: 123)
  link: 公式サイトへのリンク（任意）。例: https://github.com/visible/visible
  tags: SNS用のハッシュタグ。例: [a11y, Web, アクセスビリティー]
  year: 採択プロジェクトの年度。例: 2020
  mentor_id: 「mentors.yml」にあるメンターIDを入力。例: yasulab
  creator_ids:
  - 「cretors.yml」にあるクリエータID。例：igarashi_ryo
  - 複数名いる場合は、複数記述します

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

_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/

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

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

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

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

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

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

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

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

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

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

具体的なデータの流れについては note 記事からご確認ください。

Mitou Junior on Jekyll


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

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 ディレクトリから確認できます 👀 ✅


🆕 新年度の採択プロジェクトを公開する

成果報告会が近づいたら、以下の手順で新年度の採択プロジェクトを公開します。

  1. README 冒頭にある手順に沿って _data/creators.yml を追加する
  2. README 冒頭にある手順に沿って _data/projects.yml を追加する
  3. 上記の情報をベースに、新年度の統計情報を _data/stats.yml に追加する
  4. トップページ (index.md) と成果報告会ページ (final.md) で表示するプロジェクトを新年度に更新する
  5. /projects ディレクトリに 20xx.md ファイルと 20xx.json ファイルを追加する
  6. コメントアウトされているトップページ (index.md) のアナウンス情報を更新する

ローカル環境で生成結果を確認したい場合は、上記セクション「Webサイトの仕組みを改善したい」の手順に沿って進めてください。

:octocat: 更新作業の例: 2023年度の採択プロジェクト公開時のPR (#144) - GitHub


💕 使用素材、著作物、ライセンスについて

各プロジェクトのカバー画像やデモ動画、および説明文などは当該プロジェクトのクリエータの著作物となります。その他のロゴ画像やプロフィール画像、および説明文なども同様に、各著作者の著作物となります。

上記の著作物を除く、Ruby のソースコード (tasks/*.rb, Gemfile, Rakefile など) や、各種設定ファイル (_config.yml, .github/workflows/*.yml など) については、以下のライセンス (MIT) のもとで自由にご活用いただけます。

The MIT License (日本語訳付き) 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 © 未踏ジュニア実行委員会