This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

ユーザー向けのドキュメントページを用意する #84

Open

0918nobita opened this issue Feb 21, 2020 · 2 comments

Labels

A-docs T-design-doc

Member

0918nobita commented Feb 21, 2020 •

edited

Loading

概要

チュートリアルやリファレンスを掲載するためのページを追加し、
関連するソースコードが変更されて master ブランチに push されるたびに
Netlify から docs.knights.dev に自動デプロイされるように設定する。

目的

ユーザーが Knights の操作方法・標準ライブラリについて調べたり、チュートリアルを通して関数型プログラミングを学習するため

背景

Knights のノードエディタ・インタプリタに触れることを通して学んでほしい内容を簡潔に示しているページがあってほしい
アプリ本体 (ノードエディタ + インタプリタ) にチュートリアル・リファレンスを統合するのは、作る側も使う側も体験が悪い

要求事項

デプロイをミスった (or デグレった) ときの修正の流れ、Netlify アカウントの権限管理等について確認する

想定される問題

依存する npm パッケージがめっちゃ増える
core-js 2系に依存する (GatsbyJS が)

実装手順

１つずつ別の PR で作業する (どれも差分がデカくなりそうなので)

GatsbyJS の導入
ヘッドレス CMS「Contentful」の設定 + GatsbyJS のビルド設定 (ヘッドレス CMS から記事の内容を取得して静的サイトを生成する)
静的サイトを Netlify にデプロイする設定の追加

※ それぞれのステップで、必要になった初期設定等を README.md または CONTRIBUTING.md に追記する

他の手段

WordPress (← 👎 ) 等の CMS を使用する

関連リンク

0918nobita added S-work-in-progress A-docs T-design-doc labels

Contributor

kirisaki commented Feb 21, 2020

Wordpress:-1::-1::-1:

Member Author

0918nobita commented Feb 23, 2020 •

edited

Loading

とりあえずヘッドレス CMS には Contentful を採用してみることにします (無料枠で十分使えて多機能なので)

0918nobita removed the S-work-in-progress label

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.