NTFのドキュメント刷新 - #728
Draft
kiyotis wants to merge 27 commits into
Draft
Conversation
* マイグレーション検証で補足が必要に思えた点について追記 * 表現を修正 * マイグレーション検証で補足が必要に思えた点について追記（英語版）
* fix: RoutesMappingの定義ファイルの再読み込み有効化の条件がアーキタイプのコメントと剥離していたため修正（英語） * fix: remove dot
2026年7月1日付でTIS株式会社と株式会社インテックが合併し、商号が TISI株式会社に変更されたため、以下を更新する。 - ja/en index.rst: 製品紹介文中の社名を TIS → TISI へ更新 - ja/en conf.py: copyright/author/latex_documents の著作権者表記を TIS Inc → TISI Inc へ更新。copyright は開始年のみの表記 (2010, TISI Inc) とし、動的な年範囲表記を廃止 Co-authored-by: kumagoro1202 <kumagoro1202@users.noreply.github.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
* fix: データ入出力ドキュメントの助詞「が」の脱字を修正 「変更することできる」「含めることできる」を、それぞれ 「変更することができる」「含めることができる」に修正する。 可能表現に必要な格助詞「が」が抜けており文法的に成立していなかった。 * fix: 「ApacheMaven」のスペース欠落を修正 examples/index.rst で製品名「Apache Maven」の間のスペースが欠落し 「ApacheMaven」となっていた箇所を修正する。同一文の直前では 「Apache Maven」と正しく表記されており、文内で表記が不統一であった。 * fix: セクション見出し「pom.xmlの修正の修正」の重複を修正 JspStaticAnalysis ツール解説のセクション見出しで語句「修正」が 重複し「pom.xmlの修正の修正」となっていたものを「pom.xmlの修正」に 修正する。見出しは目次にもそのまま露出するため表記を正す。 * fix: 固有名詞「Apache Software Foundation」の綴り誤りを修正 blank_project/maven.rst で「Foudation」となっていた綴りを 正しい「Foundation」に修正する。英語版ドキュメント (en/.../maven.rst)では正しく「Foundation」と記載されており、 日本語版のみの誤記であることを確認済み。 --------- Co-authored-by: kumagoro1202 <kumagoro1202@users.noreply.github.com>
* fix: 用語「コンポーネント設定ファイル」への表記統一(prh辞書準拠) doma_adaptor.rst で1箇所だけ「コンポーネント定義ファイル」と なっていた表記を、プロジェクトのprh辞書(.textlint/conf/prh.yml)が 正とする「コンポーネント設定ファイル」に統一する。同ファイル内の 他の箇所(75/270/337/340/385行目)は既に「設定ファイル」表記であり、 本箇所のみが不統一であった。 * fix: 長音表記をprh辞書に統一(サーバ/インターセプタ/フォーマッタ/ユーザ) プロジェクトのprh辞書(.textlint/conf/prh.yml)が正とする長音記号を 省く表記に、本文中で残存していた以下の箇所を統一する。 - role_check.rst: 「サーバー側」→「サーバ側」、 「他のインターセプター」→「他のインターセプタ」 - java_static_analysis/index.rst: 「コードフォーマッター機能」→ 「コードフォーマッタ機能」(地の文のみ) - biz_samples/12/index.rst: 「ユーザー管理サービス」→「ユーザ管理サービス」、 コメント内「ユーザー情報」→「ユーザ情報」 固有名詞・引用は対象外とした(AWS公式製品名「Amazon Cognito ユーザープール」、外部記事タイトル「Javaコードフォーマッター解説」等は 変更していない)。 * fix: プライバシーポリシー脚注の「ユーザーエージェント」をprh辞書に統一(ユーザエージェント) --------- Co-authored-by: kumagoro1202 <kumagoro1202@users.noreply.github.com>
ja配下のハンドラドキュメント13ファイルについて、以下の誤字脱字および コード例・設定例の不整合を修正した。 - 誤変換の修正: 「補足」→「捕捉」(例外の捕捉)、「開放」→「解放」(リソースの解放) - 英単語の誤字: cherset→charset、Servcies→Services - 日本語の誤字・脱字: リクエストパラータ→リクエストパラメータ、 セッションスストア→セッションストア、ようする→要する、 原因不足となった→原因となった、フォーワード→フォワード(表記統一) - コード例の修正: JAX-RSアノテーションの@欠落(GET→@get)、 XML設定例の自己閉じタグ誤り(csrf_token_verification_handler、 health_check_endpoint_handler)、箇条書きの閉じ括弧欠落 - 説明の誤記: writeBody/buildResponseBodyの説明の 「リクエストボディ」→「レスポンスボディ」、export→exportsプロパティ、 CSP出力例の'src'→'self'、検査対象→検証対象(表記統一) Co-authored-by: kumagoro1202 <kumagoro1202@users.noreply.github.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
* docs(batch): バッチ機能ドキュメントの誤字・脱字・表記を修正 バッチ機能配下のドキュメントに含まれる以下の記述を修正する。 - 「バリデージョン機能付き」を「バリデーション機能付き」に修正（architecture.rst / feature_details.rst。リンク先クラス名は変更していない） - 「DBに接続しない場は」の脱字を「DBに接続しない場合は」に修正 - 「状態を保持しすることで」の余分な「し」を除去 - 動作確認手順の項番の飛び（2の次が5）を3に修正 - 「データーベース」の長音表記を周辺記述に合わせ「データベース」に統一 - い抜き表現「提供してる」を「提供している」に修正 - 「出来る」等のかな漢字表記を周辺記述に合わせ「できる」に統一 - tip内のです・ます調を文書全体のである調に統一 * docs(blank_project): セットアップ手順ドキュメントの誤字・脱字・表記を修正 ブランクプロジェクトのセットアップ手順配下のドキュメントに含まれる以下の記述を修正する。 - 「H2 Databaes Engine」のスペルミスを「H2 Database Engine」に修正（同一ページ内の正しい表記に合わせる） - 「アプリケーション実装する際に」の助詞「を」の脱字を「アプリケーションを実装する際に」と補う - 「一端終了」を「一旦終了」に修正 - ブラウザ名「FireFox」を正式表記「Firefox」に統一（同一ページ内の正しい表記に合わせる） - プロキシ説明の「インターネットに直接できない」の脱字を「インターネットに直接アクセスできない」と補う - 標準エンコーディング変更の見出しの脱字（「実行環境依存」の「依存」欠落）を本文表記に合わせて補う * docs(blank_project): 固有名詞「Apache Software Foundation」の綴り誤りを修正 maven.rstの「Apache Software Foudation」を正しい綴り「Foundation」に修正した(nが欠落していた)。 * Revert "docs(blank_project): 固有名詞「Apache Software Foundation」の綴り誤りを修正" This reverts commit 6be215f. --------- Co-authored-by: kumagoro1202 <kumagoro1202@users.noreply.github.com>
日本語ドキュメント全ファイルの逐語検証で発見された誤字脱字・表記誤りを修正する。 読者の誤解やコード例のコンパイルエラーにつながる箇所を対象とし、意味・仕様の変更は一切含まない。 主な修正内容: - 誤字・脱字: 「規程している」→「規定している」(SimpleDateFormat構文の説明6箇所)、 「補足」→「捕捉」(例外捕捉の誤変換4箇所)、「少数点以下桁数」→「小数点以下桁数」、 「こどで」→「ことで」、「チェックボッス」→「チェックボックス」、「リストボック」→「リストボックス」ほか - 綴り誤り: Local→Locale、PATTER1/2→PATTERN1/2、FileLogWiter→FileLogWriter、 gettter→getter、classpth→classpath、propertis→properties、compnent→component、 Blog/Clog→Blob/Clob、SendFailureException→SendFailedException、opeion→option - コード例の誤り: class→record(レコード宣言構文)、new hashMap<>()→new HashMap<>()、 HashTable→HashMap(null値格納例のため)、文末セミコロン欠落の補完、 ディレクティブ例のコロン誤植(negative-pack-sign-nibbleL→negative-pack-sign-nibble:) - 例の不整合: 半角数字定義の"01234567890"(11文字・0重複)→"0123456789"、 JSON例の"ななえ2"→"なまえ2"(XML例・Map例と統一) - 表記統一: 全角引用符'*'・"yyyy-MM-dd HH:mm:ss.SSS"→他ページと同じ``リテラル``表記 - RST構造: database.rstの定義リスト本文のインデント半角1字ずれを修正、 脚注ラベル[#validaiton]→[#validation](参照・定義とも)、閉じ括弧欠落の補完 Co-authored-by: kumagoro1202 <kumagoro1202@users.noreply.github.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
日本語ドキュメント全数調査で発見された誤字・脱字・サンプルコードの 不整合を修正する。対象はテスティングフレームワークガイド(単体テスト ガイド・テストFWガイド・テストツール)およびツールボックス配下の 計18ファイル。 主な修正内容: - 綴り誤りの修正(ExectionContext→ExecutionContext、 DbAccsessTestSupport→DbAccessTestSupport、-Xverfiy→-Xverify、 Prefernce→Preference、nablarch-jarxrs→nablarch-jaxrs 等) - サンプルコードのコンパイル不整合の修正(未定義変数の参照、 閉じ括弧の過不足、宣言と参照の綴り不一致) - 日付フォーマット例のy欠落(yyy→yyyy)と設定例の日付不一致の修正 - 助詞の誤り・脱字・重複表現の修正(「複数シートを分割」→ 「複数シートに分割」、「の修正の修正」→「の修正」等) - 全角/半角括弧の不整合・スペース記号の誤記の修正 Co-authored-by: kumagoro1202 <kumagoro1202@users.noreply.github.com>
* ウェブアプリケーション編ドキュメントの誤字脱字を修正 - feature_details.rst: 「フレークワーク」→「フレームワーク」(2箇所) - forward_error_page.rst: 「場合がる」→「場合がある」 - client_create2.rst: messages.properties見出しのインデントを周辺の定義リスト(2スペース)に統一 - project_bulk_update/index.rst: JSPパス見出し2箇所に欠落していた「view/」を補完(実体は/WEB-INF/view/projectBulk/) - project_download/index.rst: 内部ラベル名project_upload-file_download_actionをページ内容に合わせproject_download-file_download_actionへ改名(参照と定義を対で変更・他ファイルからの参照なし) - project_update/index.rst: SQLファイル名client.sqlを実体に合わせClient.sqlへ修正、「データベースの更新」節の導入文のコピペ起因の誤り(「更新内容の確認について」)を修正 - project_upload/index.rst: 手順番号3の重複を解消し1〜7に振り直し * ウェブサービス編ドキュメントの誤字とサンプルコードの構文誤りを修正 - http_messaging/feature_details.rst, rest/feature_details.rst: 「フレークワーク」→「フレームワーク」(計3箇所) - rest/feature_details/resource_signature.rst: サンプルコードのセミコロン欠落とclassキーワード欠落(public UserSearchForm→public class UserSearchForm)を修正 - rest/getting_started(create/search/update): サンプルコードで欠落していた閉じ波括弧を補完し、対応が取れたコードに修正 * アダプタ編ドキュメントの誤字・表記ゆれを修正 - doma_adaptor.rst: 「実行されるようにある」→「実行されるようになる」 - redishealthchecker_lettuce_adaptor.rst: 「発生しなけければ」→「発生しなければ」 - mail_sender_velocity_adaptor.rst: 設定例の説明文で参照するクラス名を直前で定義したVelocityEngineFactoryに修正(ConfigurationFactoryは他ページからの流用残り) - micrometer_adaptor.rst: 「Mbean」→「MBean」(JMX用語の正式表記) - router_adaptor.rst: 「Jboss」「Wildfly」を同ページ内の表記「JBoss」「WildFly」に統一 * 各種ドキュメントの誤字・表記ゆれを修正 - biz_samples/01/index.rst: 見出しの「AuthenticaionUtil」→「AuthenticationUtil」(2箇所)、コメントの「Strign」→「String」 - biz_samples/04/0402_ExtendedFieldType.rst: サンプル実装クラスのパッケージ名converterを実体のconvertorに修正(nablarch-biz-sample-allの実ソースで確認) - about_nablarch/versionup_policy.rst: 文中に混入していた不要な半角スペース2箇所を除去 - messaging/db/feature_details/multiple_process.rst: 実装例のセミコロン二重(;;)を修正 - nablarch/architecture.rst: 「データベース接続の取得・開放」→「解放」(同一文内の表記に統一) - setting_guide/CustomizingConfigurations/index.rst: 「デフォルトコンフィギュレーション」を文書内多数派の「デフォルトコンフィグレーション」に統一、内部アンカー名の綴り誤り(overwite→overwrite・componet→component)を参照と定義を対で修正 --------- Co-authored-by: kumagoro1202 <kumagoro1202@users.noreply.github.com>
docker buildが失敗していた原因は、Dockerfile最終行の `npm audit fix` が 終了コード1で返っていたためである。依存ツリーにhigh深刻度の脆弱性が残存し、 それらが破壊的メジャーアップグレードでしか解消できないため、--force無しの `npm audit fix` は脆弱性を残したまま非0終了し、ビルド全体を失敗させていた。 対応内容: - Dockerfile最終行から `npm audit fix` を除去し、脆弱性監査をビルドの合否判定 から切り離した。残存する脆弱性の本質対応は破壊的変更を伴うため別イシューとする。 - `npm install` を `npm ci` へ移行し、package-lock.json を新規に追加した。 lockfileが無いと依存が解決の都度変わり、脆弱性DBの更新時期によってビルドが 突然壊れる。lockfileで依存を固定して再現性を確保する。 - lockfileをコミット対象とするため .gitignore の package-lock.json 除外を解除した。 - 監査をビルド合否から外す方針をDockerfileのコメントとして明文化した。 検証: docker build成功、日本語・英語のフルSphinxビルドが警告0件で成功、 textlintの実行を確認済み。 Co-authored-by: kumagoro1202 <kumagoro1202@users.noreply.github.com>
) ビルド成果物を一切変えずにビルド環境を最新化する。 - ベースイメージ: python:3.8.18-slim (EOL) -> python:3.10.20-slim - Sphinx 1.3.6 は Python 3.11 の正規表現仕様変更で起動不能のため、 現行ツールチェーンでの上限は 3.10 系 - docutils-ast-writer の use_2to3 対応のため setuptools==57.5.0 に 固定し --no-build-isolation でインストール - Python 3.10 で削除された stdlib parser モジュールの互換シムを追加 (無指定コードブロックのハイライト判定を 3.8 時代と同一に保つため) - Node.js: 実体は Debian 標準の 18 系だったものを NodeSource 22 系 LTS へ - 従来はベースイメージに curl が無く NodeSource セットアップが無言で 失敗し、Debian 標準の nodejs 18.20.4 が入っていた - curl を明示導入し、スクリプトをファイル保存してから実行することで ダウンロード失敗をビルド失敗として検知するよう修正 - textlint: 12.2.1 -> 15.7.1 / patch-package: 6.4.7 -> 8.0.1 - npm audit の high 深刻度 5 件を解消 (残りは moderate 3 件のみ: textlint 15 の MCP サーバ機能由来で lint 用途では影響なし) - textlint-plugin-rst 0.1.1 と既存パッチはそのまま動作 - Python 支援ライブラリ (requests / urllib3 / certifi / lxml ほか) を更新 - HTML 生成に関与する Sphinx / docutils / Pygments / テーマ等は据え置き 検証: 更新前後の環境で日英ドキュメントをフルビルドし、全 2378 ファイルの SHA-256 が完全一致することを確認 (更新前環境の 2 回ビルドで決定性も確認)。 textlint は同一入力に対し新旧で同一の検出結果を返すことを確認。 Co-authored-by: kumagoro1202 <kumagoro1202@users.noreply.github.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
extract_sections.py でRST(L3)・Markdown(H3)のセクションを機械的に抽出し、 build_mapping.sh で現行解説書(47ファイル→212セクション)とinput資料(10ファイル→152セクション)の CSVを生成する。2回実行でmd5が一致することを確認済み。 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See steering.