Red Hat Bugzilla – Bug 1250614
[Doc Bug Fix] Changes from bug 1236119 should also appear in Installation Guide, chapter 3.3
Last modified: 2015-10-20 08:46:02 EDT
Changes produced as a result of bug 1236119 are present in the Migration Guide. However, the same kind of information is also present in the Installation Guide, chapter 3.3. These should be somehow kept in sync.
I would not add this here (two places to maintain)
I would vote for a introduction like this:
If this installation replace a former version you might conside to upgrade.
The migration guide will show aproaches for major/minor/micro updates
The problem is that there are _already_ two places that compete with the same type of content. It makes sense to me to have this content available both in Install Guide and Migration Guide, but it doesn't make sense to me that the content is different. Some information is available only in the Install Guide, some only in the Migration Guide.
AFAIK, documentation topics can be reused, so that the maintenance overhead doesn't increase. That would be my favorite solution.
Hi Ladislav. You're correct in the assertion that we can reuse topics between books with minimal effort and maintenance overhead.
Should all of Sande's new content (Migration Guide Chapter 2.4: "About Migrations and Upgrades" ) be included, or only a subset of it?
Also, Sande, should we need to, would you be willing to work with conditional tagging in the Migration Guide content?
Hi Scott, I'd be happy to. I'll grab this bug.
I took a quick look at chapter 2.4 About Migrations and Upgrades in the Migration Guide again and I think that:
- the Major Upgrades part probably doesn't need to be in the Installation Guide
- the Minor Updates part directly competes with chapter 3.3. Upgrading JBoss EAP 6 of the Installation Guide (mostly with 3.3.1 and 3.3.2)
- the Cumulative Patches part seems to summarize chapters 3.1. About Patches and Upgrades and 3.2. Patching JBoss EAP 6 and so doesn't need to be in the Installation Guide
Which, to me, results in the need to somehow merge the "Minor Updates" part of chapter 2.4 About Migrations and Upgrades in the Migration Guide with chapter 3.3. Upgrading JBoss EAP 6 of the Installation Guide. They both contain important information that is missing from the other part.
Thanks Ladislav. I will move this to ON_QA after the next build.