Ensure that the "Building on Horizon" tutorial is up to date

[Jonathan Bell]

I have followed the guide to create a new dashboard found here: http://docs.openstack.org/developer/horizon/topics/tutorial.html
but the new dashboard does not show up as a tab on the horizon splash. When I navigate to the tab it says URL does not match any known pattern. I have created a urls.py in the panel folder under my dashboard pointing to an index view, and added my market dashboard to the installed_apps and dashboards in the settings file under openstack_dashboard. Are there other files I must configure in order to get the url included in the url_patterns?

Thanks!
Jonathan Bell

[Victoria Martinez de la Cruz (vkmc)]

Hi Jonathan! Please ask about this in http://ask.openstack.org.

[Julie Pichon (jpichon)]

I actually was the one who suggested coming here from Ask OpenStack ( https://ask.openstack.org/en/question/25856/horizon-dashboard-demo-failed/ ). It's happened before that these steps become outdated so it might be worthwhile for someone to go through the tutorial and confirm whether it's still valid or not. I'm setting the status back to New based on this (though I haven't had a chance to confirm yet). Thank you!

[Julie Pichon (jpichon)]

Adding the low hanging fruit tag, if someone could check if the steps are accurate and where things are broken and report back here, that would be very helpful. Patches fixing any discovered issue are welcome too!

[Ana Krivokapić (akrivoka)]

Changed the title of the bug accordingly.

[Gloria Gu (gloria-gu)]

This is not a low hanging fruit for a newbee like me. The instruction doesn't match what is generated. Downloaded demo in the link in the tutorial. The demo is not working either. It might be a low hanging fruit for someone who is already familiar with horizon.

[Julie Pichon (jpichon)]

On the contrary I think it's exactly the kind of feedback we're looking for: if it doesn't work, a list of action items that need to be fixed. Thanks!

I think that link to the demo needs to go away, it's just too old to be relevant now. (<- Things To Fix #1)

If you could write the list of what you did and how the results didn't match what you expected this would be very helpful. Someone else can pick it up from there if you're not sure how to fix it then. Thanks for the feedback so far!

[Gloria Gu (gloria-gu)]

Ok, I will take a look again. Meanwhile , I can remove the link in the tutorial.

[Julie Pichon (jpichon)]

Great, thanks. Please use the "Partial-Bug" notation in the commit message when doing so - https://wiki.openstack.org/wiki/GitCommitMessages#Including_external_references .

[Cindy Lu (clu-m)]

This would be an ambitious task, but it would be great to have a new tutorial, albeit a simple, clean one. :)

I have seen many questions about the "Building on Horizon" tutorial *not working*.
https://answers.launchpad.net/horizon/+question/249631

Plus the fact that at the end in the 'Conclusion' section, it says to download the code... only it doesn't work. This can be really frustrating. o.O

[OpenStack Infra (hudson-openstack)]

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

[Gloria Gu (gloria-gu)]

I am in the process of removing the reference of outdated demo from the tutorial

[Gloria Gu (gloria-gu)]

I compiled the complain list by refollowing the steps...again, I got lost

demo dashboard doesn't work

Creating a dashboard
----------------------
Structure
------------
* They don't match what are generated and the orders of files.
* where the visualization folder is supposed to appear under horizon?

Defining dashboard
-------------------
* Does not tell what are auto generated code and what user need to add/modify.
* For auto geneated code, class names don't match
* The flow of defining dashboard is confusing...need to make it a little clearer for example remove the panel flocking portion and penel group ...deal with them in the defining panel section

Creating a panel
-----------------

Structure
-----------
* They don't match what are generated and the orders of files.

Defining a panel
-------------------
* Does not tell what are auto generated code and what user need to add/modify.

Tables, Tabs, and Views
-------------------------
Defining a table
----------------
* the code doesn't include all the imports as well, not sure what to import, some have mutitple entries during importing

Defining tabs
---------------
* which file to add the code? tabs.py?
* the code doesn't include all the imports as well, not sure what to import some have mutitple entries during importing

Tying it together in a view
-----------------------------
* tab name doesn't match actual created in tabs file

template
----------
* which template and which file to modify?
* how to create _flocking.html stated in the tabs.py?

For the rest of portion, not sure what are correct, and what need to do.

[Gloria Gu (gloria-gu)]

The current tutorial basically need to accomplish the followings regarding the create a dashboard, a tab group, tab and a table. I got my own version working. I think I am going to rewrite the tutorial based on my version of simple code.

[Cindy Lu (clu-m)]

Hi Gloria,

Thanks for the compiled list!!!

Your tutorial sounds great. It will be helpful to new Horizon people. :)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/99186
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=81197c3afef5ef4021e331df67772ffb6be0ca43
Submitter: Jenkins
Branch: master

commit 81197c3afef5ef4021e331df67772ffb6be0ca43
Author: Gloria Gu <email address hidden>
Date: Tue Jun 10 09:53:41 2014 -0700

    Removed the link to the outdated horizon demo

    Partial-Bug: #1298490
    Change-Id: If7d5e5e4c7468300c6e019b79337e39777b39657

[Gloria Gu (gloria-gu)]

I continue on the rewriting...steps are all there and working ...someone in my team will try them next week to see if they are clear enough to follow.

It still need better explanation and wordsmith. I think my next check in will be more about the steps and after that will have another check in for some simple explanation and better wordings.

[Julie Pichon (jpichon)]

This is great, thank you Gloria.

[OpenStack Infra (hudson-openstack)]

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

[Gloria Gu (gloria-gu)]

As original plan, I planed to just check in steps. ...it turned out to be that can not separate steps and wordings..work on lot of wording now...but should push another patch shortly.

[Carl Bader (carl-bader)]

Gloria this looks and works very well. Steps are very clear and explanations are concise and very helpful.

[Gloria Gu (gloria-gu)]

So far I have 12 patches...think the tutorial is in a good shape compared with the existing one.
It is really hard to make it perfect but I think it will be beneficial to lots of new folks out there. Can core members take a look at the following review? https://review.openstack.org/#/c/100718/

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/100718
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=2e7f16fecf2b343dcec22d2b0ae7a6d9705a8aba
Submitter: Jenkins
Branch: master

commit 2e7f16fecf2b343dcec22d2b0ae7a6d9705a8aba
Author: Gloria Gu <email address hidden>
Date: Tue Jun 17 15:57:14 2014 -0700

    Updated the steps of the tutorial

    The existing tutorial is outdated, hard to follow and does not
    work.

    Update or rewrite the steps of the tutorial to create a dashboard,
    a panel, a tab group, a tab and a table which contains some data
    from backend a table which contains some data from backend.

    Make sure the steps work.

    Updated the brief explanation as well.

    Closes-Bug: #1298490

    Change-Id: I7c6769fa6b8cd5488afc03e8a284342549a6745f