VMware {code} Community
laurentsd
VMware Employee
VMware Employee

Hands-on Lab 1811-07 with a plugin tutorial

The Hands-on Lab for building an HTML plugin that was introduced at VMworld 2017 is available at VMware Learning Platform, search for lab 1811-07 in the Software Defined Datacenter category.  This lab is based on plugin-seed so you will also learn how to get started with that tool (available on our Fling site)

We are interested in your feedback for future improvements of the lab, thanks!

(please note that the latest version of this lab includes a text file containing all the code and commands to copy, so that you no longer have to use the awkward drag & drop from the manual)

2 Replies
ChrisSmith2
Enthusiast
Enthusiast

This lab is extremely useful, particularly when looking at migrating a plugin from the existing SDK samples (JQuery-based) to Angular/Clarity. The new "copy.txt" in the VM makes it much easier to work through, although the estimated time is still very optimistic (it took me about 4 hours to get through module 1).

My feedback:

The biggest issue is that the lab is a single very long module. If any errors are made it is very hard to undo them / debug the issue - you may have to start completely from scratch, which means up to 3-4 hours working back through all of the steps you already covered successfully. It would be very helpful to break it into more modules, where you can continue with your environment through to the next step, but can restart/skip directly to a module if you have any problems or need to restart/resume.

Suggested modules:
1) Introduction.
2) Development environment setup (starting with "Getting Started with the Plugin Seed").
3) Developing plugins using test data (starting with "Backend APIs mocked with json-server").
4) Deploying to vSphere Client and testing with live data (starting with "Deploy myPlugin to vSphere Client").
5) Enhancing the plugin (starting with "Monitor view navigation buttons").
6) Adding views (starting with "Add a VM Monitor View").

7) (existing module 2).


There are also some issues with the specific steps in module 1:

Step 47: "best of both words" should be "worlds"

Step 50: "iddle" should be "idle"

Step 81: "the whole content" source code doesn't exist on this page. This is confusing - it looks like this line should be removed, as the relevant content is added bit-by-bit in steps 82-83; I copied the code from the "copy.txt" file that actually seems to be intended for the end of step 83 instead. Step 81 shouldn't mention anything about copying code, but instead state clearly that it will be building up that view over the next few steps.

Step 88: As explicit URLs are being used ("/vm-10" etc.), it is important that "Live data" is switched off. If it is still on from earlier tests, you just get a blank page which is very confusing. A comment here to ensure "Live data" is off would be very useful. The phrase "real values" also confuses the issue here (it's not showing values for real VMs, just test data from the "db.json").

Step 90: This adds error handling - it might help to reorder this to be done before step 82 to improve the experience when switching live/test data (see comment for step 88).

Step 90: The last screenshot and couple of lines seem wrong/out of context. The picture shows the red alert box, but no changes have been made to make it possible to show this, and the URL quoted is for "vm-10" but talks about "vm-20". The screenshot has "vm-20" in both name and in the error; it appears to be the end-goal after future steps have been performed (so saying "now refreshed with a red alert box" is misleading at this time). This section should really be moved to the end of step 92 (or a new step following 92).

0 Kudos
laurentsd
VMware Employee
VMware Employee

Thanks for the feedback Chris!   I agree with you that the next version should be broken down into smaller modules that can be easily be picked up at any point. The problems in the manual that you reported will be fixed soon.

0 Kudos