[B! textlint][CI] efclのブックマーク

textlint + Reviewdog + GitLab CI でアドベントカレンダーの校正をした話

textlint + Reviewdog + GitLabCIでアドベントカレンダーの校正をした話 2021.12.15 アドベントカレンダー2021 エンジニアテクノロジーこれは、Qiita Advent Calendar 2021 GitLabの15日目の記事です。はじめにこんにちは、フォルシアにて、旅行会社向けの web アプリケーションを開発しています、エンジニアの高橋です。普段のアプリ開発の業務のほかに技術広報も兼任しており、弊社で開催しているアドベントカレンダーの運営もお手伝いしています。フォルシアではもともと、社内のイベントとしてアドベントカレンダーを始めましたが、2018 年からは弊社ブログ︵FORCIA CUBE︶にて外部の方向けに記事を公開しています。社内のみで記事を公開していた頃は、誰かが多少締め切りをすぎても﹁かまへんかまへん﹂と言えますが、外部に公

efcl 2021/12/20

textlintをGitLab CIで回す話

textlint
CI

リンク

ドキュメントの文章校正には、textlintが便利 - Cybozu Inside Out | サイボウズエンジニアのブログ

こんにちは！開発部テクニカルコミュニケーションチーム︵以下、TCチーム︶の原嶋です。さてさて。みなさん、ドキュメントの文章校正︵以下、校正︶ってどんな風にやっていますか？目視チェックでバッチリだぜ！という方ももちろんいると思うのですが、チェックポイントが多いと指摘が漏れてしまいがちですよね。そして、会社の公式文書となれば、チェックポイントはあれもこれもと山のようになります。TCチームでも長年校正に頭をかかえていましたが、textlint と＋αのツールを使って、校正の悩みを解決しました。今回はその経緯をお話させてください。校正って確認する項目がたくさんTCチームでは、サイボウズ製品のユーザーサポートコンテンツ︵ヘルプやリリースノートなど︶を作成しているのですが、それらのコンテンツは会社の公式文書なので、毎回の校正でチェックする項目が多々あるんです。校正おわったー

efcl 2020/09/12

ドキュメントでのtextlint利用

textlint
CI

リンク

【ライター募集】ねとらぼで“エンタメ系”の記事作成を手伝ってくれる方を募集します

突然ですがねとらぼエンタ編集部ののとです皆さんこんにちは。ねとらぼエンタ編集部ののとほのかです。編集経験ゼロなのに﹁映画が好き！﹂﹁エンタメの世界に入りたい！﹂﹁編集者ってなんかかっこいい！﹂﹁酒飲みたい﹂という理由で編集記者となってはや2年が過ぎました。目下の夢は新チャンネル﹁のとらぼ﹂の立ち上げです。私が在籍しているねとらぼエンタは2015年10月に産声をあげ、現在では月間5000万PVを超える規模となりました︵これもひとえに皆さまのおかげです︶。それでもまだまだ扱いたいネタはたくさん！ということで、ねとらぼエンタでは力を貸してくれる新しい仲間を募集します！ときにはカブトムシも食べる楽しい職場です︵関連記事︶ライター募集応募フォーム︵ねとらぼエンタ︶はこちらねとらぼって何？そもそも、皆さんは﹁ねとらぼ﹂にどんなイメージをお持ちでしょうか？　私は、椅子に縛り付けられてV

efcl 2019/06/14

「執筆環境もそれまで社内で標準的に使われていた秀丸からVSCode+textlint+GitHubという環境に移行しました」 CircleCIで継続的校正

リンク

ヘルプの校正をtextlint・prh・CircleCIを使って自動化する - ヴェルク - IT起業の記録

boardのヘルプは、Githubで管理し、プルリクエストを使って編集・校正を行っています。ざっくり以下のような運用になっています。新規のヘルプは、僕が書いてプルリクエストを出し、編集者がチェックする既存のヘルプは、編集者が気づいた点を随時修正してプルリクエストを出し、僕が内容をチェックする所定のブランチにマージされると、ステージング環境・本番環境に自動的に反映されるこれについては、以前詳しく書いたので、興味がある方は下記をご覧ください。 tamukai.blog.velc.jp 実際に運用していて、この仕組みはとても気に入っているのですが、せっかくここまで仕組みができたので、もう一歩進めて、機械的にチェックできるところは、編集者の時間を使わずにチェック・修正をしたいなと考えました。文章の場合、機械的にチェックできるのは、たとえば、以下のようなものです。・「とくに/特に」のよ

efcl 2019/03/29

ヘルプページの校正システム

textlint
CI

リンク

GitLab CI + docker-reviewを使って、Markdownをtextlintしてからpdf化するCI環境を作ってみた - メモ的な思考的な

最近、Markdownからpdfを作る機会がありました。 pdf化を都度行うのは手間だったため、何か良い方法がないかを探したところ、 Markdown > Re:VIEW > pdf という経路でpdfを作成できそうでした。ただ、手動でpdfを生成するのが手間だったため、GitLabCIを使って、push後にMarkdownをtextlintしてからpdf化するCI環境を作ってみました。目次環境 GitLabCIの設定ファイル .gitlab-ci.yml の作成ステージを定義ジョブを定義ジョブ﹁対象のMarkdownにtextlintを実行﹂の詳細を定義ジョブ﹁Markdownをpdf化する﹂の詳細を定義 textlint向けの定義 prh.yml .textlintrc review-pdfmaker向けの設定 config.ymlの設定 pdf化するコンテンツの設定

efcl 2019/03/29

CIでMarkdownをtextlintでチェックしてPDF化する

リンク

CI/CDによるアジャイルなブログ記事作成

この記事では、アジャイルなアプローチでブログ記事を作成する方法を紹介します。また、継続的インテグレーション・継続的デリバリをブログ執筆に導入します。 TL;DR# まずは、やったことの概要を紹介します。 GitHubで記事のissueを作成 topic branch作成︵posts/xxxx-xxxx︶ topic branchからマスタbranchにpull-requestを立てるGit commit &Git pushを小さく繰り返して執筆を進める GitHubにpushされるたび、Circle CIとNetlifyでビルド & テストを実施 textlint prh markdown lint codecov gatsby build ︵Netlify Previewも裏で動く︶ GitHubのProtect branches機能を設定し、マスタbranchへのマージ可能状態を、

efcl 2018/08/09

GitHub + textlint + Circle CI + Netlifyを使ったブログ記事のCI/CDフローについて

リンク

reviewdogを使ってtextlintの結果をPull Requestに書き込む方法 - Qiita

この記事は、textlintのチェックでエラーとなった結果を、Pull Requestのレビューコメントとして書く設定をする手順をまとめたものです。 textlintを使っているCI環境に数行追加する程度で、次のようにPull Requestのコメントに指摘内容が自動で書き込めるようになります。 reviewdogを使うことで、CIからレビューコメントとしてLintの結果を書き込むことができます。CIでLintがエラーとなった場合、CIの画面までエラーを見に行く必要があって面倒です。 reviewdogを使うことで、PRの画面上にLintのエラーが表示されるので手間が省けて便利です。基本的には次の記事と同様です。 textlintをTravis CIで動かして継続的に文章をチェックする - Qiita Travis CIでtextlintの指摘をPull Requestのレビューコメン

efcl 2017/02/13

textlintのチェック結果をTravis CI経由でGitHubのPull Requestへ書き込む設定について。 CIが落ちてもPR上でチェックができるようになる

リンク

GitHub - seikichi/pronto-textlint: Pronto runner for textlint

efcl 2016/10/29

Prontoのtextlint向けのrunner

textlint
CI

リンク

継続的インテグレーションで実現するWebメディアの執筆フロー

はじめに Webメディアの執筆作業に継続的インテグレーション(Continuous Integration)、継続的デリバリー(Continuous Delivery)の考えを取り入れ、GitHub/CircleCIを使って効率化をした話です。最初の環境構築さえしてしまえば、非エンジニアでも問題なくこの仕組みに乗ることが出来ています。これらのツールは発想次第でいろいろな使い方ができるということを、メディアの運営者やエンジニアに限らずいろいろな人に知って頂ければ良いのかなと。背景この仕組みは私がWebメディアを運営する会社にて、開発と記事のライティングや編集を同時に経験したことをベースに作り上げました。記事執筆をしていると、書いた記事をどう保管するのか・編集者の修正を執筆者にフィードバックするにはどうするのか・といった課題が出てきます。その問題を解決するため、Github/CircleC

efcl 2015/11/25

執筆、編集、CIフローの話。 textlintで校正支援APIを叩いたりなど。自分がやってる形とはまた違って面白い https://azu.gitbooks.io/nodefest-technical-writing/content/

リンク

はてなブックマーク

タグ

関連タグで絞り込む (6)

textlintとCIに関するefclのブックマーク (9)

お知らせ

今週のはてなブックマーク数ランキング（2024年7月第3週）

今週のはてなブックマーク数ランキング（2024年7月第2週）

はてなブックマーク透明性レポート（2024年 2月-2024年4月）

公式Twitter

キーボードショートカット一覧

はてなブックマーク

公式Twitter

はてなのサービス