Project

General

Profile

Backport(バックポート) #1514

ドキュメントに開発環境用ファイル削除の手順がない

Added by Shogo Kawahara about 11 years ago. Updated about 10 years ago.

Status:
Fixed(完了)
Priority:
High(高め)
Target version:
Start date:
2010-08-19
Due date:
% Done:

100%


Description

Overview

---
OpenPNE3_Setup_Guide.txt

  • デバッグ用環境である web/*_dev.php に対する処置について記述するべきです。
    • (project:disable かファイル自体の削除が望ましい)


Related issues

Related to OpenPNE 3 - Bug(バグ) #1512: ドキュメントに開発環境用ファイル削除の手順がない Fixed(完了) 2010-08-19
Related to OpenPNE 3 - Bug(バグ) #1566: 日本語バージョンアップドキュメントの表現、文言の修正 Fixed(完了) 2010-09-07

Associated revisions

Revision abe75a8b (diff)
Added by Shinichi Urabe about 11 years ago

Update OpenPNE 3.4.x version up documents (fixes #1514)

Revision e71b93eb (diff)
Added by Shinichi Urabe about 11 years ago

Update OpenPNE 3.4.x Setup documents (fixes #1514)

Revision 77a5ecaf (diff)
Added by Shinichi Urabe about 11 years ago

Revert "Update OpenPNE 3.4.x Setup documents (fixes #1514)"

This reverts commit e71b93eb6dd8defd57c841cdfc1e55550a168061.

Revision 190e9879 (diff)
Added by Shinichi Urabe about 11 years ago

Revert "Update OpenPNE 3.4.x version up documents (fixes #1514)"

This reverts commit abe75a8b76fe71b4caacd56c66e2e0f61bc7460f.

Revision c92f2313 (diff)
Added by Shinichi Urabe about 11 years ago

Additional steps to remove development files (fixes #1514)

History

#1 Updated by Shogo Kawahara about 11 years ago

  • Tracker changed from Bug(バグ) to Backport(バックポート)

#2 Updated by Shinichi Urabe about 11 years ago

  • Assignee set to Shinichi Urabe

#3 Updated by Shinichi Urabe about 11 years ago

  • Status changed from New(新規) to Accepted(着手)

#4 Updated by Shinichi Urabe about 11 years ago

  • Status changed from Accepted(着手) to Pending Review(レビュー待ち)
  • % Done changed from 0 to 50

更新履歴 abe75a8b76fe71b4caacd56c66e2e0f61bc7460f で適用されました。

#5 Updated by Shinichi Urabe about 11 years ago

更新履歴 e71b93eb6dd8defd57c841cdfc1e55550a168061 で適用されました。

#6 Updated by Hiroki Mogi about 11 years ago

テストを行ないました。問題ありませんでした。

#7 Updated by Kousuke Ebihara about 11 years ago

まず、このチケットの OpenPNE3_Version_Up_Guide.txt に対する二点の指摘がどちらも誤っています。指摘された点については現状のドキュメントで間違いということはありません。また、手順の削除などが多くみられますがこれは極めてリスクのある行動であることを認識するべきです。開発環境用コントローラの削除についてのみ追記し、英語版の日本語版への追従を反映したら、他は戻すことも検討してください。

また、テスター側もおそらくここまでの変更がおこなわれることは意図しておらず、フロントコントローラの削除のみを確認し、他の手順の変更については動作テストをおこなっていない可能性が高いです。そういう意味でも、このチケットでの手順の削除等は控えておくのが無難だと思います。

  • バージョンアップガイドに「This document is for updating OpenPNE 3.2/OpenPNE 3.4 to OpenPNE 3.4.x.」という記載がありますが、この手順が今後大きく変わることはありません(微細な変更があったとしてもアップデート後のバージョンに依存するはずで、アップデート前のバージョンに影響することは通常あり得ません)。つまり、アップデート前のバージョンは ORM に Doctrine を使用している OpenPNE 3.2.0 以降であるとさえ言えばよく、そういう意味で修正前のバージョン表記の方が適切であったと言えます。修正前の表記がわかりにくいというのは確かなので、「OpenPNE 3.2 以降」とするのが妥当ではないでしょうか。
  • 「モデルの再構築」の手順が削除されていますが、これはなぜでしょうか? ソースコードを交換した場合、モデルの再構築をおこなわないと openpneMigrateTask の 63 行目が動作しなくなるのではないでしょうか? この手順を実施しないように openpneMigrateTask を修正することは適切だと思いますが、それは安定版でおこなうべきことではありません。
  • 「プラグインディレクトリのコピー」の手順が削除されていますが、これはなぜでしょうか? この手順を実施しないと、ソースコードを交換した場合、バージョンアップ前にインストールしたプラグインと、プラグインのバージョンなどの情報が引き継げなくなります。なぜ消したのですか?
  • 「OpenPNE.yml の設定値を環境に合わせて変更してください。特に base_url と mail_domain はメール投稿、メール配信の際に利用されるので必ず設定をおこなってください。」この表記は OpenPNE 3.4 の間は決して削除してはいけません。 OpenPNE 3.2.0 リリース時点では、当初、 OpenPNE.yml の設定は必須ではなかったからです。なぜ消したのですか?
  • 「OpenPNE 3.2 で管理画面からメールテンプレートを変更し、 OpenPNE 3.4 にアップデートした際に問題が生じた場合、 OpenPNE.yml の is_restrict_mail_template を false に設定してください。」この表記は OpenPNE 3.4 の間は決して削除してはいけません。なぜ消したのですか?
  • データベースのバックアップはあくまで例示としてとどめておくのがよいと思います(「メール配信設定」の「設定例」のようなイメージです)。
  • パスを例示する際は /path/to/**** などと表記しているのでそれにあわせてください。
  • 今回の変更で、 OpenPNE3_Version_Up_Guide.txt にだけ「Webサーバー」という表記が登場するようになりましたが、
    • ドキュメントすべてにおいて半角文字と全角文字の間には半角スペースを入れるような形式で記述されているので、それにあわせてください。半角スペースを入れるフォーマット(e.g. マイクロソフトのスタイル: http://www.microsoft.com/Language/ja-jp/StyleGuides.aspx, ORACLE のスタイル: http://wikis.sun.com/display/g11nhome/Language+Style+Guides )を採用するか入れないものを採用するかについては議論が分かれるところですが、できるだけスペースを入れる形にあわせておくのがよいのではないかと思います。
    • 他の箇所では、カタカナ語の語尾の長音を伸ばさずに「サーバ」と表記しています。こちらについても議論の分かれるところで、ルールを設けて統一できるようにするべきとは日々感じているところですが、「サーバー」については「サーバ」に統一する方向で修正するのがよいのではないかと思います。
  • 英語版を日本語版に追いつかせるのであれば、以下が不足していると思います。
    • OpenPNE3_Setup_Guide.txt において、 「※ OpenPNE .4.x は、セットアップ時に指定されたデータベースを削除し、作り直します。かならず専用のデータベースを用意してセットアップを実施してください。」に対応する英語の記述がありません。
    • OpenPNE3_Setup_Guide.txt において、「設定ファイルの作成」に対応する手順がありません。
    • OpenPNE3_Setup_Guide.txt において、「メール配信設定」に対応する手順がありません。

#8 Updated by Kousuke Ebihara about 11 years ago

  • Status changed from Pending Review(レビュー待ち) to Rejected(差し戻し)

#9 Updated by Kousuke Ebihara about 11 years ago

このチケットではフロントコントローラの削除の手順を追加するのみとします。

このチケットで判明した課題と、その対応について以下に列挙します。

  • このチケットのタイトルと説明文を適切なものに変更します
  • 英語版ドキュメントを日本語版ドキュメントに追従させる件については、別にバグチケットを切っておこないます (3.4.7 ではおこないません)
  • 「このドキュメントは、 OpenPNE 3.2.0 + から OpenPNE 3.4.x へのバージョンアップ作業の手順を示したものです。」をわかりやすい表現に変更する(OpenPNE 3.2 以降、などにする)件については、別にバグチケットを切っておこないます (3.4.7 ではおこないません)
  • その他軽微な表現の訂正・改善やドキュメント手順自体の改善については、極力 3.7.x (場合によっては 3.6.x)でのみの改善としたいと思います
  • また、ドキュメントの適切な管理方法の確立や、表現におけるルールを定めておく必要があります

#10 Updated by Shinichi Urabe about 11 years ago

  • Status changed from Rejected(差し戻し) to Pending Review(レビュー待ち)

更新履歴 c92f23137fd26958622cc2078de1ca007975d211 で適用されました。

#11 Updated by Shinichi Urabe about 11 years ago

更新履歴 190e98797c1057d427e4b777b5f55d28e7d0874e で適用されました。

#12 Updated by Shinichi Urabe about 11 years ago

更新履歴 77a5ecaf1f69fd6aa589306f46f173b286441c24 で適用されました。

#13 Updated by Shinichi Urabe about 11 years ago

  • Subject changed from ドキュメントの情報の修正 to ドキュメントに開発環境用ファイル削除の手順がない

#14 Updated by Kousuke Ebihara about 11 years ago

  • Status changed from Pending Review(レビュー待ち) to Pending Testing(テスト待ち)
  • % Done changed from 50 to 70

#15 Updated by Hiroki Mogi about 11 years ago

  • Status changed from Pending Testing(テスト待ち) to Fixed(完了)
  • % Done changed from 70 to 100
以下の手順でテストを行ない、開発環境用ファイルが削除される事を確認しました。チケットをfixします。
  1. コンソールを開き、OpenPNE3.4.7のルートディレクトリへ移動する
  2. ./symfony project:clear-controllers を実行する

#16 Updated by Minoru Takai about 10 years ago

note-9 で記述されている件について補足しておきます。

  • 英語版ドキュメントを日本語版ドキュメントに追従させる件については、別にバグチケットを切っておこないます (3.4.7 ではおこないません)
  • 「このドキュメントは、 OpenPNE 3.2.0 + から OpenPNE 3.4.x へのバージョンアップ作業の手順を示したものです。」をわかりやすい表現に変更する(OpenPNE 3.2 以降、などにする)件については、別にバグチケットを切っておこないます (3.4.7 ではおこないません)
  • その他軽微な表現の訂正・改善やドキュメント手順自体の改善については、極力 3.7.x (場合によっては 3.6.x)でのみの改善としたいと思います

このうち、 "3.2.0 +" が分かりにくいというバージョンの表現については #1566 (と note-9 )で検討・対応されています。

英語版のドキュメントについては #1567 で対応されています。

  • また、ドキュメントの適切な管理方法の確立や、表現におけるルールを定めておく必要があります

master ブランチにおけるチケット #1566, #1567 では、未だにドキュメントの改善に関して対応手順などが整理されておらず、場当たり的な対応となっています。今後のドキュメントの更新や保守のためにも管理方法やルールを検討する必要がありそうです。

Also available in: Atom PDF