Missing step in the building a dashboard tutorial

Bug #1401332 reported by Tyr Johanson
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Dashboard (Horizon)
Confirmed
Low
Vishal Manchanda

Bug Description

http://docs.openstack.org/developer/horizon/topics/tutorial.html

On the tutorial page
----------------------------
Open the index.html file in the mydashboard/mypanel/templates/mypanel directory, the auto-generated code is like the following:

{% extends 'mydashboard/base.html' %}
{% load i18n %}
{% block title %}{% trans "Mypanel" %}{% endblock %}

{% block page_header %}
    {% include "horizon/common/_page_header.html" with title=_("Mypanel") %}
{% endblock page_header %}

{% block mydashboard_main %}
{% endblock %}
----------------------------

Acutally, the generated index.html starts with:
{% extends 'base.html' %}

If you don't change this, the mydashboard_main block is never included, and the new instance table added in the tutorial is never shown, causing confusion for learners. If you *cut and paste* the tutorial index.html, it will work, but if you follow the steps, the new panel will not work.

I think the tutorial is missing a step to edit the "extends" portion of the template.

Tyr Johanson (tyr-6)
Changed in horizon:
assignee: nobody → Tyr Johanson (tyr-6)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to horizon (master)

Fix proposed to branch: master
Review: https://review.openstack.org/141496

Changed in horizon:
status: New → In Progress
Revision history for this message
Lin Hua Cheng (lin-hua-cheng) wrote :
Revision history for this message
Lin Hua Cheng (lin-hua-cheng) wrote :

When I followed the steps, it actually looks correct.

The problem is the fix for https://bugs.launchpad.net/ubuntu/+source/horizon/+bug/1325099 caused a regression. The templates for panel should have <dashboard>/base.html. The instructions assume that the dashboard is created first, so having the template using the base from the created dashboard sounds right.

Changed in horizon:
importance: Undecided → Medium
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on horizon (master)

Change abandoned by David Lyle (<email address hidden>) on branch: master
Review: https://review.openstack.org/141496
Reason: This review is > 4 weeks without comment, and failed Jenkins the last time it was checked. We are abandoning this for now. Feel free to reactivate the review by pressing the restore button and leaving a 'recheck' comment to get fresh test results.

Akihiro Motoki (amotoki)
Changed in horizon:
assignee: Tyr Johanson (tyr-6) → nobody
status: In Progress → New
Akihiro Motoki (amotoki)
Changed in horizon:
importance: Medium → Undecided
tags: added: documentation
Changed in horizon:
importance: Undecided → Low
status: New → Confirmed
Changed in horizon:
assignee: nobody → Vishal Manchanda (vishalmanchanda)
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

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