prismatix-jp / techdoc-ja

日本語で情報技術ドキュメント（仕様書やドキュメント等）を記述するためのオーサリング環境

techdoc-ja

日本語で情報技術ドキュメント（仕様書やドキュメント等）を記述するための、オーサリング環境を提供します。

要件

• ドキュメントを Markdown 形式で記述する。
  • コードブロックのシンタックスハイライトに対応する。
  • PlantUML による作図に対応する。
  • 日本語の記述に対応する。（PlantUML 内も含めて）
• GitHub でドキュメントプロジェクトを管理し、PR で編集する。
• Circle CI によって継続的に、次の処理を実行する。
  • RedPen, textlint および markdownlint により文章の自動校正をする。
  • Gitbook によって、HTML および PDF 出力を得る。
  • 出力結果は Amazon S3 にデプロイする。

成果物

前述の Circle CI による処理のために、下記のソフトウェアを利用します。

• Node.js v9.3.0
• OpenJDK 1.8.0_131
• RedPen 1.10.1
• textlint v10.0.0
• markdownlint-cli v0.7.1
• GitBook 3.2.2
• graphviz version 2.38.0 (20140413.2041)
• Python/3.4.2
• aws-cli 1.14.11

これらをインストールした Docker イメージ およびその利用方法を、本プロジェクトの成果物とします。

techdoc-ja's Issues

メンテナンスの手順をまとめておく

アップデートしてDockerHubにイメージをアップして、みたいなやつ

PDFのビルドに失敗する

InstallRequiredError: "ebook-convert" is not installed.
Install it from Calibre: https://calibre-ebook.com

techdoc-ja のライブラリのアップデートメンテナンス

概要

techdoc-ja のライブラリのアップデートメンテナンス

• MkDocs 用のアップデート

この Issue の close 条件

• メンテナンスが完了する

prismatix機能一覧をホームへ追加する

Dockerベースイメージアップデート

Docker ベースイメージが古いせいか、現在 Dockerfile からのイメージ作成でコケる

Removing intermediate container d67dda731375
Step 3/17 : ENV LANG ja_JP.UTF-8
 ---> Running in 5d8e92376d1f
 ---> c5b637d0e674
Removing intermediate container 5d8e92376d1f
Step 4/17 : RUN echo "deb http://http.debian.net/debian jessie-backports main" >>/etc/apt/sources.list   && apt-get clean   && apt-get update   && apt-get install -y locales-all
 ---> Running in 9097295c5312
Ign http://deb.debian.org jessie InRelease
Get:1 http://deb.debian.org jessie-updates InRelease [16.3 kB]
Get:2 http://security.debian.org jessie/updates InRelease [44.9 kB]
Get:3 http://deb.debian.org jessie Release.gpg [1652 B]
Get:4 http://deb.debian.org jessie Release [77.3 kB]
Ign http://http.debian.net jessie-backports InRelease
Get:5 http://deb.debian.org jessie-updates/main amd64 Packages [20 B]
Ign http://http.debian.net jessie-backports Release.gpg
Get:6 http://security.debian.org jessie/updates/main amd64 Packages [983 kB]
Ign http://http.debian.net jessie-backports Release
Err http://http.debian.net jessie-backports/main amd64 Packages
  
Get:7 http://deb.debian.org jessie/main amd64 Packages [9098 kB]
Err http://http.debian.net jessie-backports/main amd64 Packages
  
Err http://http.debian.net jessie-backports/main amd64 Packages
  
Err http://http.debian.net jessie-backports/main amd64 Packages
  
Err http://http.debian.net jessie-backports/main amd64 Packages
  404  Not Found
Fetched 10.2 MB in 4s (2313 kB/s)
W: Failed to fetch http://http.debian.net/debian/dists/jessie-backports/main/binary-amd64/Packages  404  Not Found

E: Some index files failed to download. They have been ignored, or old ones used instead.

解決策

Docker ベースイメージのバージョンを上げる

FROM node:14.14.0-buster-slim

Docker hub へのイメージ Push のフローを整備する

現在

以下の Docker hub Registry にPush されている
https://hub.docker.com/r/classmethod/techdoc-ja/

課題

• Pushの作業手順が不明
• イメージを Push する処理が自動化されていない
• Githubのリポジトリの組織と、Docker hubの組織が合っていない

Close 条件

• DockerイメージのPush手順が確立される
• Push手順が自動化される
• Push 先が明確になる

update textlint modules

see textlint/textlint#455

Dockerイメージのスリム化

alpineベースでイメージを作る。