The docs will be slightly restructured for CFME 3.2. This may impact links in the appliance, so these changes should be tracked.
Deon,..I'm assigning this back to you until we're clear on what the restructuring of docs means. However,..once you have the details, we should have a clearer picture if the UI needs to change, and where.
As of version 5.4.0.0.19.20150410165622_ad23806 (beta2) the Configure->About documentation page is still listing the 3.0 documentation.
Hi Shikha, Does the work you performed on checking links cover the use case outlined here, or are there some other areas we should check? Let me know what you think. Kind regards, Andrew
Andrew: I veririfed that the latest 5.4 build does not have the latest doc updates for 5.4. As you had previously sent me updates for the 5.3 release,...can you also provide a link to the updated 5.4 docs. Once I have them,..I will get them into the next build.
The updated docs will be added to the 5.4 source, once the 5.4 branch is created. There are one-for-one changes,..so existing links will point to updated docs. However,..there are a few new pdfs that will need new links. There's also 2 pdfs that replace an existing pdf. For now, I will update the pdfs, but not remove any, until the UI links are created. See this thread for more info and going to assign this issue to the UI team. ----- Forwarded Message ----- > From: "Dan Clarizio" <dclarizi> > To: "John Prause" <jprause> > Cc: "cloudforms-eng-build" <cloudforms-eng-build> > Sent: Monday, May 11, 2015 5:03:01 PM > Subject: Re: Docs on the appliance > > Please do . . . we'll get it done in July if that's ok with you. > > ----- Original Message ----- > > > From: "John Prause" <jprause> > > To: "Dan Clarizio" <dclarizi> > > Cc: "cloudforms-eng-build" <cloudforms-eng-build> > > Sent: Monday, May 11, 2015 1:59:41 PM > > Subject: Fwd: Docs on the appliance > > > Hi Dan, > > > Hate to send this again,..but with the final build of 5.4 coming soon,. > > just > > wanted to be sure about these pdfs. > > It appears there will need to be a change for links that point to the new > > pdfs. (see below) > > > Also, according to Andrew, two of the pdfs will replace an existing pdf. > > If that's true, we'll also need links to these two pdfs, as well as the > > removal of a link. > > > Would you like me to open a BZ to handle this issue? > > > Thanks, > > John ----- Forwarded Message ----- > From: "Andrew Dahms" <adahms> > To: "John Prause" <jprause> > Cc: "Dan Clarizio" <dclarizi>, "Harpreet Kataria" <hkataria>, "Marianne Feifer" > <mfeifer>, "Deborah Rieden" <drieden>, "Chris Pelland" <cpelland>, "Russell > Laliberte" <rlaliber>, "Ella Ballard" <dlackey>, "cloudforms-eng-build" > <cloudforms-eng-build> > Sent: Tuesday, May 12, 2015 7:31:30 AM > Subject: Re: Docs on the appliance > > Hi John, > > Thank you for following up - the list there is correct. > > I will indeed be providing the Settings and Operations guide next week for > the GA candidate build, but the quick start content has be consumed into the > other guides. As such, the full list of guides that I will be providing next > week will be the following - > > - cfme_automate.pdf > - cfme_control.pdf > - cfme_insight.pdf > - cfme_rest.pdf > - cfme_soap.pdf > - cfme_settingandops.pdf > - cfme_user.pdf > > You are also correct that cfme_integrate.pdf is to be pulled, and has been > replaced by cfme_rest.pdf and cfme_soap.pdf. > > Let me know if anything else is required to make the updates! > > Kind regards, > > Andrew Dahms > > ----- Original Message ----- > From: "John Prause" <jprause> > To: "Andrew Dahms" <adahms>, "Dan Clarizio" <dclarizi>, > "Harpreet Kataria" <hkataria>, "Marianne Feifer" > <mfeifer> > Cc: "Deborah Rieden" <drieden>, "Chris Pelland" > <cpelland>, "Russell Laliberte" <rlaliber>, "Ella > Ballard" <dlackey>, "cloudforms-eng-build" > <cloudforms-eng-build> > Sent: Monday, 11 May, 2015 11:41:24 PM > Subject: Re: Docs on the appliance > > Hi Andrew, > > Thanks and I just looked at what was turned over which is the following: > - cfme_automate.pdf (this is an update to an existing pdf) > - cfme_control.pdf (this is an update to an existing pdf) > - cfme_insight.pdf (this is an update to an existing pdf) > - cfme_rest.pdf (this is a new pdf) > - cfme_soap.pdf (this is a new pdf) > - cfme_user.pdf (this is a new pdf) > > I assume you'll be providing the following updates next week (which are not > listed above): > - cfme_quickstart.pdf > - cfme_settingandops.pdf > > and am I to understand that the existing cfme_integrate.pdf is to be pulled, > since as you say, the cfme_rest.pdf and cfme_soap.pdf replace it? > While I can easily get the three updated pdfs intergrated,..I'll also need to > ping the UI dev team since they'll need to provide (or remove) links. > > > Thanks, > John > > > ----- Original Message ----- > > From: "Andrew Dahms" <adahms> > > To: "Deborah Rieden" <drieden> > > Cc: "Chris Pelland" <cpelland>, "John Prause" > > <jprause>, "Russell Laliberte" > > <rlaliber>, "Ella Ballard" <dlackey> > > Sent: Sunday, May 10, 2015 11:35:32 PM > > Subject: Re: Docs on the appliance > > > > Hi everyone, > > > > I hope this finds you all well. > > > > As discussed, here is a link to a tar file containing the PDFs for the 3.2 > > appliance - > > > > http://file.bne.redhat.com/~adahms/files/3.2_Documentation.tar.gz > > > > While the majority of titles are the same as those in the 3.1 set, several > > of > > the guides have changed, such as the Integration Services guide, which has > > been broken into the REST API guide and SOAP API guide as per the > > documentation plan. > > > > With regards to the naming of the PDF files themselves, I have followed the > > convention used with the files to date, such as cfme_rest.pdf for the new > > REST API guide. > > > > With the GA candidate build to be created next Monday on 18 May, I will > > provide another set of PDFs at around this time next Monday BNE time so > > that > > an updated version of the documentation can be included in the build. > > > > Let me know if you have any questions or concerns. > > > > Kind regards, > > > > Andrew Dahms
Okay. I'll wait for the 5.4 branch, and the pdfs to be committed.
The updated and new PDFs have been commited to the 5.4.z branch for 5.4.0.1 build. The PDF links have also been updated.
5.4.0.0.26.20150511144816_f924bd4 the appliance still has the 3.0/5.2 docs. Customer Portal shows 3.1 as latest version
Andrew when you send over the remaining pdfs, you can clear this flag for information.
All links have been updated for the 5.4.0.5 build.
Verified that all the links in the Configure->About documentation page point to the 3.2 documentation.
Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory, and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://rhn.redhat.com/errata/RHBA-2015-1100.html