Skip to content

サイトデザインとテンプレートの更新 #89

Open
@dynamis

Description

@dynamis

現在 chirimen.org の更新が難しいという声があるが、その原因はいくつかあるように思います。

既に解消しているものはそう分かるように、解消できないものも緩和する方法があるものはそうしたいのでルールとドキュメントの整理をしたいです。

以下は私が見て思った現状とそれに対する提案です。合意が取れるようであれば How To を README なり /feedback ページなりに記載していきたいと思いますが如何でしょうか?

master を直接編集せずに PR を作らなければならないルール

github の 簡単な編集はどんどん master に直接コミットして事後報告・事後レビューも OK としても良さそうに思います (問題が起きるようなコミットが繰り返されるようであればその時に見直す前提で)。

また、PR を作るにしてもオンラインのブラウザ上で出来るという手順の説明を書いて、少なくとも主要なメンバーが気軽に更新できる雰囲気にしたいです。

jekyll のビルド環境を整えなければプレビューして編集・コミットが出来ない

ビルド環境の VM を作って頂いて大分やりやすくなったと思いますが、カジュアルにブラウザだけで編集出来る方がより望ましいです。大きなテンプレートの改変は開発環境を整えて行った方が良いとしても、比較的簡単なものならプレビューをしたい場合でもブラウザの操作だけで行いたいです。

そのため、Netlify の Deploy Preview 環境をセットアップしました。

ブラウザでファイルを編集してコミットするときに master ではなく PR として保存すれば数十秒後には自動でプレビューサイトまで自動で作成され、CHIRIMEN Slack の #github チャンネルに通知されるはずです。

ビルド環境無しでも編集できる How To ページを書いて、これでプレビュー・レビューなども必要に応じてできる体制として進めてはどうでしょうか。

jekyll のテンプレートがやや複雑でぱっと見では何をどう編集すれば良いか分からない

Web 開発者としてはこの程度のテンプレートは理解して編集できるのですが、正直初めてさんが編集するには余り直感的ではなく敷居が高いテンプレートになっている印象です。

md ファイルが各 URL ページに直接対応するデフォルト github pages とテンプレートファイルの組み合わせくらいにシンプルだとやりやすくなる気がします。

例えばチュートリアルサイトはデザインもシンプルすぎですが編集はかなりしやすいものにできたと思っています: https://tutorial.chirimen.org/feedback

現状のサイトが整理されていなくてどう手を付けて良いか分からない

サイトデザインと構成は直さないと手を付けにくいですね。何とかしたいです。

英語の併記が必要

同一ページへの併記をしている限り仕方ないですね。トップページなどは併記しつつも en/ja ディレクトリを分けて en ページの一部では google 翻訳へのリンクを張るという、現在の Tutorial ページのような逃げ方をするのもありかも知れません。

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions