Fuel for OpenStack

Review and modify Fuel docs landing page

Bug #1326601 reported by Meg McRoberts
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Fuel for OpenStack
Fix Committed
Medium
Dmitry Ilyin
Fuel for OpenStack 5.1

Bug Description

Some issues to consider:
- Should the PDF titles be so much more prominent than the HTML titles?
- The left frame that contains the HTML titles should be sizeable and scrollable
- Should be able to expand and collapse doc titles and subtitles
- Should we make a downloadable package of docs available so people can read them locally without a web connection?
- Graphic sizing is an issue -- if the size is set so the graphic is reasonable in PDF, it is often too big for the HTML docs
- Other issues?

Bogdan Dobrelya (bogdando)
Changed in fuel:
assignee: nobody → Dmitry Ilyin (idv1985)
milestone: none → 5.1
importance: Undecided → Medium
status: New → Confirmed
Revision history for this message
Dmitry Ilyin (idv1985) wrote :

- Yes! PDF is million times more impotant then HTML.
- Yes, left frame is bad and should be fixed.
- It would be nice.
- That's why I love PDFs so much.
- Without size picture will be either 100% or fit width. I usually set size.

OpenStack Infra (hudson-openstack)
Changed in fuel:
status: Confirmed → In Progress
Revision history for this message
Dmitry Ilyin (idv1985) wrote :

I've made some improvements https://review.openstack.org/#/c/102534/
Iguess it would be enough for now. If I invent more lets form another bug.

Changed in fuel:
status: In Progress → Fix Committed
Revision history for this message
Meg McRoberts (dreidellhasa) wrote :

Good work, Dmitry!

This solves #2 and #3 in my original list.

About the PDF versus HTML... People don't initially realize that they have a choice when they
open the doc page -- people come to me and ask why we can't produce HTML docs along with
the PDF.

I think most people are going to use both. The xrefs-as-links in the HTML docs are very useful
and they don't work as well in the PDF. And we have situations like the second half of the Planning Guide,
which has example configuration information that eats up a lot of paper and may not be worth printing.
If people look at the PDF before they print, they can specify the pages to print but otherwise... It might
be good to create a separate guide with "Configuration Examples" or something if a signigicant number
are printing it off.

As for the graphics... I DO specify the width... But graphics that are way too big in HTML are too small
to read easily in PDF. And the align property is causing problems; without it, the screen shots are
mostly defaulting to left-justified in HTML and centered in PDF.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to fuel-docs (master)

Reviewed: https://review.openstack.org/102534
Committed: https://git.openstack.org/cgit/stackforge/fuel-docs/commit/?id=f780842f61adadf2844214545a4b2d0a331c59a9
Submitter: Jenkins
Branch: master

commit f780842f61adadf2844214545a4b2d0a331c59a9
Author: Dmitry Ilyin <email address hidden>
Date: Wed Jun 25 18:06:18 2014 +0400

    Make some fixes to the documentation template

    * Sidebar made a little wider
    * Implemented collapsible title in the sidebar toc
    * Removed useless maxdepth, let them be max by default.

    Change-Id: I8537c6f91fe33aa1b94c43328dadb7ea41630dc5
    Closes-Bug: 1326601

Dmitry Pyzhov (dpyzhov)
no longer affects: fuel/5.0.x
Dmitry Ilyin (idv1985)
no longer affects: fuel/5.0.x
Dmitry Pyzhov (dpyzhov)
no longer affects: fuel/5.1.x
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.