リリースノートのセクションを追加し、v6.0 と過去の版を掲載

概要

ドキュメントに「リリースノート」のセクションを追加し、v6.0 と過去の版(v4.2c〜v5.9)を載せた。

v6.0 から、リリースノートは版ごとの HTML・PDF を作らず、ドキュメントに載せる。日本語と英語の切り替えを、ドキュメントサイトに任せられるためである。issue #17 (closed) は「設置しなくてもよい」も挙げていたが、この理由で設置する。ダウンロードページからは、ドキュメントのページへリンクする。

過去の版は、公開当時の内容の再録である。PDF からの変換で崩れた箇条書きや改行は原本のとおりに直し、各版に繰り返し載っていた版と公開日の一覧は省いた。英語版があるのは v5.1.1 以降で、v5.1 以前は英語サイトでも日本語のページが表示される。

リリースノートのページは、その版で何が変わったかの記録である。後の版で仕様が変わったときは、変わった版のページに書き、前の版のページは書き直さない。この扱いを WRITING_POLICY に定義した。ファイル名は、外部からリンクされるので変えない(CONTRIBUTING)。v5.9 以前を archive に分けたのは、サイドバーがセクション直下のページをすべて並べるためである。

v6.0 のページは、ドキュメントに v6.0 のタグを打つ前にマージする必要がある。他の v6.0 向けの MR がマージされたので、main(fe6afd4c)にリベースしたうえで v6.0 のページを見直した(下の表の eac31dcb〜6781c21f)。レビューで挙がった互換性の5項目と、それを調べる中で見つかった項目を、v5.9 と v6.0 のコードで確かめて「互換性に関わる変更」に加え、最初の版の後にマージされた v6.0 向けのドキュメントの MR(20件)を各項目に反映した。再レビューの指摘(5件)は ae4985c7 で反映した。タグの直前にマージする。

変更内容

コミット 要約
ec243bd6 Add release notes section and define its policy WRITING_POLICY にセクションの定義を追加。ナビゲーション(イントロダクションの直後)、トップページの入口、一覧ページを追加
7d5137f6 Add release notes for v6.0 v6.0 のリリースノート(日本語・英語)
566377a3 Add release notes for v5.9 and earlier as an archive v4.2c〜v5.9 のリリースノート(日本語16版、英語9版)と図7枚
507d1f2a Simplify the release notes index pages 一覧ページを、各版へのリンクの一覧だけにした
1a2f41d9 Drop the post-publication freeze from the release notes policy 「公開後は改訂しない」をやめ、後の版に合わせて前の版のページを書き直さない、という方針だけにした(レビュー対応)
eac31dcb Add compatibility changes found after the first draft of the v6.0 release notes 「互換性に関わる変更」に、拡張Lagrange法のペナルティ、接触ペアを含むメッシュの要素ベース分割、動解析の !STEP、自由度混在用の要素への熱荷重、リスタートファイルの形式、!AMPLITUDE の VALUE=ABSOLUTE、!SPRING、固有ベクトルの正規化を加え、inp 形式の既定のセット名を TYPE=ABAQUS の項目に足した。各カテゴリの項目もこれに合わせた(レビュー対応)
0f274079 Reflect documentation merged after the first draft of the v6.0 release notes 後からマージされたドキュメントの MR を該当する項目にリンクし、面-面接触の設定、761・781 の有限回転、SA-AMG の LAPACK 依存、GPU で計算される範囲などを項目に補った
6781c21f Update the documentation entries of the v6.0 release notes 「ドキュメント」のカテゴリに、ビルドガイドの追加分、出力例の差し替え、既存の記述の修正を加えた
ae4985c7 Apply the second review of the v6.0 release notes マイルストーン 6.1 の FrontISTR#898 へのリンクを外し、MATRIXFORMAT の CSR が使えるビルドを明記した。「ドキュメント」に、STATICEIGEN の結果ファイルの説明の追記と「リリースノートの追加」(!100 (merged))の項目を加え、ドキュメントサイトの移行の項目に !111 (merged) をリンクした(レビュー対応)

Closes #17 (closed)

Edited by inagaki

Merge request reports

Loading
Loading