Home

Welcome to the istiobyexample-ja wiki!

This is a project to translate askmeegs/istiobyexample.

前準備

Hugo > 0.60
- sudo snap install hugoやsudo apt install hugoによりインストール可能(ubuntu)
- snapの方がバージョンが新しい
- dockerイメージを利用することも可能

翻訳者の対応

本プロジェクトをforkもしくはmasterブランチから新規ブランチを作成
./content/<article>を翻訳する。翻訳は2行目のtitleも含む
./data/items.tomlから翻訳したページのtitleを修正する。これがトップページでの記事リンクタイトルとなる
hugoでビルドできるか，表示が崩れていないかをチェックする。方法は大きく以下2種
- hugo serverでテストサーバを起動し，localhost:1313にブラウザアクセス
- hugo -t hugo-notepadium --minify --enableGitInfoでビルドし，./docs以下を確認
masterにPull Request

~~mergeした人の対応~~

~~1. Merge後にmasterブランチにて./deploy.sh(git pushまで実行されるため注意)~~
→ GitHub Actionで自動化したため不要

（随時更新）

フォーマットとして日本語と英語が混在する場合は英語の前後をスペースでは挟む
英語の固有名詞は英語のまま（Namespace, Deployment等）
リンク先の記事・ページに日本語版があれば日本語版をリンクする。ref: https://github.com/istiobyexample-ja/istiobyexample/pull/5#issuecomment-606370110

Hugoを使った静的ページをGitHub pagesで公開
- -t hugo-notepadiumオプションにてテーマを設定
- --minifyにてコンパクション（ja独自）
- --enableGitInfoにてlastmodとしてcommit時の時刻を設定（ja独自）
gh-pagesブランチをgithub-pagesで公開
ビルドおよびgh-pages push はgithub actionで自動実行
- GitHub Pages Actionを使用
- .github/workflows/gh-pages.ymlにてワークフローを定義
./config.tomlがサイト設定
./content以下が記事のソース
layoutやassetsのファイルがサイト構成
- hugoでビルドするとthemeにoverrideされる
- layout/index.htmlがトップページ