【GitHub Actions】Markdown 執筆に textlintの自動校正を取り入れる | DevelopersIO
背景 GitHub で Markdown 執筆活動 複数人で協力してドキュメントを執筆しています。 執筆の流れは下図のとおり。 執筆ブランチ を作成する 執筆ブランチ で執筆活動を行う mainブランチ にマージするための プルリクエスト を作成する プルリクエスト内でレビュー (必要に応じて修正) を行う 最後に mainブランチ へマージする (1. に戻る) 最低限 Git や GitHub 周りの操作を把握できたら、この方法は結構良いと感じています。 以下のようなメリットを享受できています。 テキストで情報を管理できる ( by Markdown ) バージョン管理ができる( by Git ) 文章レビューの流れを統一できる( by GitHub ) textlint で文章校正 さて、執筆活動において より良い文章 を書くために textlint を活用しています。 textli
私のチームで行っているドキュメント管理方法の紹介(GitHub Actions, S3, AsciiDoc) | DevelopersIO
ドキュメントツールのインストール(Windows) Macの場合の設定方法は、本項の後に記載 PowerShellの起動 各種ツールをインストールするため、PowerShellを管理者として実行 Windowsボタンを押下 powershell と入力 右クリックで管理者として実行 を選択します Chocolateyのインストール 本手順は前述で起動したPowerShellを利用 1.Chocolatey のサイトにアクセスし、インストールコマンドをクリップボードへコピー 2.前項でコピーしたコマンドをPowerShellにペーストして実行します Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServiceP
GitHub Actions + reviewdogでtextlintを実行する - ひよこまめ
この記事では、文章校正ツールであるtextlintのチェックでエラーになったときの結果を、GitHubのPull Requestへコメントする設定について説明します。 textlintはGitHub Actionsを使って実行し、reviewdogを使ってPull Requestへコメントします。 reviewdogはGitHub Actionsで使えるDockerベースのPublic reviewdog actionsを公開しています。 しかしtextlint用のactionsはないので、この記事ではワークフローの定義ファイルを自作します。 動作を確認した環境 GitHub Actions β版（YAML Syntax）reviewdog v0.9.13textlint v11.4.0GitHub Actionsのワークフローの作成 GitHub Actionsを設定するリポジトリを準備
GitHubの機能をフルに使って職務経歴書の継続的インテグレーションを実現する
GitHub で職務経歴書を公開 & 継続的に改善していく環境を作ったのでその紹介です。 リポジトリはこちらです。 kawamataryo/resume なぜ職務経歴書を？ 今のチームがとても好きなので転職の予定はないのですが、「安定しているときこそ職務経歴書をまとめておくべき。本当に職務経歴書が必要なときはメンタルが消耗していて書く余裕はない」という話を最近知り合いから聞き、それは確かにと思い書き初めました。どうせ書くなら何か面白いことをしたいなと GitHub に公開 & CI 環境の構築をやってみました。 機能紹介 🌐 GitHub Pages で Web ページとしての公開 Markdown + GitHub のファイルビューでも良いのですが、より見やすいほうが好ましいですよね。 GitHub の無料ホスティグ GitHub Pages を使って Web ページとして公開していま
ドキュメントの文章校正には、textlintが便利 - Cybozu Inside Out | サイボウズエンジニアのブログ
こんにちは！ 開発部 テクニカルコミュニケーションチーム（以下、TCチーム）の原嶋です。 さてさて。 みなさん、ドキュメントの文章校正（以下、校正）ってどんな風にやっていますか？ 目視チェックでバッチリだぜ！という方も もちろんいると思うのですが、チェックポイントが多いと指摘が漏れてしまいがちですよね。そして、会社の公式文書となれば、チェックポイントはあれもこれもと山のようになります。 TCチームでも長年 校正に頭をかかえていましたが、textlint と＋αのツール を使って、校正の悩みを解決しました。 今回はその経緯をお話させてください。 校正って確認する項目がたくさん TCチームでは、サイボウズ製品のユーザーサポートコンテンツ（ヘルプやリリースノートなど）を作成しているのですが、 それらのコンテンツは会社の公式文書なので、毎回の校正でチェックする項目が多々あるんです。 校正おわったー
ヘルプの校正をtextlint・prh・CircleCIを使って自動化する - ヴェルク - IT起業の記録
boardのヘルプは、Githubで管理し、プルリクエストを使って編集・校正を行っています。 ざっくり以下のような運用になっています。 新規のヘルプは、僕が書いてプルリクエストを出し、編集者がチェックする 既存のヘルプは、編集者が気づいた点を随時修正してプルリクエストを出し、僕が内容をチェックする 所定のブランチにマージされると、ステージング環境・本番環境に自動的に反映される これについては、以前詳しく書いたので、興味がある方は下記をご覧ください。 tamukai.blog.velc.jp 実際に運用していて、この仕組みはとても気に入っているのですが、せっかくここまで仕組みができたので、もう一歩進めて、機械的にチェックできるところは、編集者の時間を使わずにチェック・修正をしたいなと考えました。 文章の場合、機械的にチェックできるのは、たとえば、以下のようなものです。 ・「とくに/特に」のよ
GitHub Actionsでtextlintしてみた | DevelopersIO
こんにちは、かたいなかです。 最近、ちょっとしたドキュメントのリポジトリに対して、textlintをかけたいと思うことがありました。しかし、textlintのためだけにCIツールを設定するとなると少し面倒だなとも感じました。 そんなとき、GitHub Actionsを使用するとリポジトリに設定ファイルを設置するだけで処理が実行できることを思い出しました。 そこで今回は、現在ベータのGitHub Actionsを使用してtextlintを実行する構成を試してみました。 GitHub Actionsは現在ベータです。 手順 GitHub ActionsのBetaにSign up GitHub ActionsはまだBetaなのでそのままで使用することはできません。 以下のリンクよりベータにサインアップし、アカウントで有効化されるまで待ちます。 https://github.com/feature
GitHubでポータルサイトドキュメントを運営して幸せになる話
WebRTC is secure,� or not secure? - WebRTC セキュリティ概説 -
ドキュメントの継続的な開発方法 | IIJ Engineers Blog
私はソフトウェア開発を主体とするエンジニアで、 クラウドサービスの開発・運用 分散処理技術の検証とサービス利用の検討 社内の開発支援環境の開発・運用 などの業務に従事していますが、今回の記事は業務とは直接的な関係は無く、私が会社で勝手自発的に行っている取り組みについて書きたいと思います。 昨今、インターネットは生活に深く浸透し、クラウドサービスを利用することで安く簡単にWebサービスを開発、公開できるようになりました。Web技術の進化や流行の移り変りも非常に激しく、既存サービスの機能追加や新規サービスの開発は頻繁に行われています。それは弊社も例外ではありません。 このような開発の現場では、リーンソフトウェア開発への取り組みなど開発手法の最適化が積極的に行われ、様々なベストプラクティスが生みだされています。それらのベストプラクティスには、 継続的インテグレーション や 継続的デプロイメント
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - heriet/slidex-textlint-example: Convert PowerPoint(pptx) slides to markdown by slidex and lint markdown by textlint