You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@brooklyn.apache.org by tbouron <gi...@git.apache.org> on 2016/03/16 13:38:42 UTC

[GitHub] brooklyn-ui pull request: Location wizard

GitHub user tbouron opened a pull request:

    https://github.com/apache/brooklyn-ui/pull/17

    Location wizard

    Add a location wizard:
    ![wizard](https://cloud.githubusercontent.com/assets/2082759/13812320/77100e60-eb73-11e5-9587-fbe901d599e3.png)
    
    This will be display on:
    1. the home page if there is no locations defined. The location number becomes a button to add a location. The wizard will be displayed as a modal in this case
    ![home](https://cloud.githubusercontent.com/assets/2082759/13812301/513220b6-eb73-11e5-9f4c-a16ab787291b.png)
    2. the catalog page, when clicking on the add location button
    ![catalog](https://cloud.githubusercontent.com/assets/2082759/13812359/9e4aaeea-eb73-11e5-99a1-6cd20432c471.png)
    3. the YAML editor page if there is no locations defined. The wizard will be displayed as a modal in this case
    ![editor](https://cloud.githubusercontent.com/assets/2082759/13812380/b9047dc4-eb73-11e5-84ff-8f34d5d2e33f.png)

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/tbouron/brooklyn-ui location-wizard

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/brooklyn-ui/pull/17.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #17
    
----
commit b500293c5f55f093c8c441255aa3edcef68ec184
Author: Thomas Bouron <th...@cloudsoftcorp.com>
Date:   2016-03-10T15:24:53Z

    WIP

commit e9409d5f46ca8542baaa61ceccadfc0f8ec64022
Author: Thomas Bouron <th...@cloudsoftcorp.com>
Date:   2016-03-11T12:10:51Z

    WIP - Better form validation, code structure and style

commit 6d927b47906793583dd63a53155c28f90742af62
Author: Thomas Bouron <th...@cloudsoftcorp.com>
Date:   2016-03-11T16:09:18Z

    WIP - Added location wizard within the catalog

commit 1286d8299209908dfec858fdf972d8b4ddca3de0
Author: Thomas Bouron <th...@cloudsoftcorp.com>
Date:   2016-03-15T16:05:15Z

    Add auto-complete for provisioning properties

commit 603119c52f69fbdf915c8d4289c1f27ae0bfa814
Author: Thomas Bouron <th...@cloudsoftcorp.com>
Date:   2016-03-16T12:30:01Z

    Add location wizard into the YAML editor

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:

    https://github.com/apache/brooklyn-ui/pull/17


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197852934
  
    We will require to add a reference to `easy-autocomplete` for licensing purposes -- ping me if you want help with that.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by tbouron <gi...@git.apache.org>.
Github user tbouron commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197405281
  
    Related PR: https://github.com/apache/brooklyn-server/pull/62 => To be merge atfer this one.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197960996
  
    re **advanced mode**
    
    what i have in mind is totally simple, user defines an id and optionally a name, and there is a single third field which is the "Parent Location" (description: "Enter the location spec which this location should extend. This could be of the form `jclouds:aws-ec2` or `named:another-location-identifier` or `localhost`. For more information see [LINK].")
    
    if possible, have autocomplete which includes all the `named:xxx` where `xxx` is everything in the locations model, and also `localhost`.  (others we can hold off on...)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197937906
  
    > What is the issue with the autocomplete? Works ok after at least one character for me.
    
    maybe it's a huge time delay or my machine.  for me it only popped up once and then vanished.  other times i couldn't get anything to show.
    
    is it possible to have ctrl-space also trigger it, and put a hint that this is supported?  that at least makes it consistent with composer and obvious that it is possible.
    
    > > the "additional configuration" page is imposing; can we make it clear that there is no need to set anything, but if you want to put constraints or special login there are many config keys available (possibly with link to the website)
    > Buttons are enabled on this screen which makes it obvious that you don't need to do anything else. But I can change the subtitle from Provisioning information about your location to Optional provisioning information about your location
    
    i find button enablement a *subtle* clue not an *obvious* one.  (*disablement* is an obvious indicator that i *cannot* proceed but if i'm taken to a screen i assume i'm supposed to do something there.  the *obvious* button in this screen is *Add configuration* which is intimidating.)
    
    additionally i'd like us to more user-friendly less techie/jargony.  the phrase *provisioning information about your location* whether optional or not isn't clear to me.  also it's too general in many cases (because the previous screen gave a bunch of provisioning information) and wrong in others (specifying a `loginUser` is not provisioning information, it's information to connect to a provisioned machine).
    
    how about text such as: *In many target locations, additional configuration may be supported. Enter any such options here. Autocomplete for some config options is available using Ctrl-Space. For information on available options consult the [LINK]Brooklyn docs. Alternatively you can skip this step.*
    
    > > I don't think localhost should be a top-level item. it's only something advanced users should try. extending an existing location is probably more important. we could call that tab "Advanced" and within it a text field for type with autocomplete allowing localhost and any named locations the user has previously set up.
    > I disagree with that. Those 3 top level location types are taken from the Brooklyn docs to be consistent!
    
    the docs have evolved, and 5 years ago pre-vagrant even `localhost` was common.  they should be updated, not this based on that.  the menu options in the docs are better, with "named locations" as the second choice.
    
    localhost is useful for techies and debugging but not a casual user who increasingly we want to target, who is trying to deploy community blueprints for use.  it is something that an advanced user who is comfortable with `ssh localhost` might do max once.  clouds, byon, and named/extending otoh are things people do routinely.
    
    (incidentally i think because `localhost` is available as a resolver you can specify it as a location in a yaml even if it isn't defined as a type.  so i'm not even sure that most users would want to click that ever!)
    
    @shartzel any input?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by tbouron <gi...@git.apache.org>.
Github user tbouron commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197965666
  
    @ahgittin autocomplete => the screenshot I have taken is one Chrome... Would be better if other people could test it then. 


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197959105
  
    > autocomplete
    
    seems to be an issue with chrome.  works fine on safari.
    
    on chrome it only displays when i navigate away and then back to the text area, oddly.
    
    the idea with ctrl-space was that this is another way to trigger it, in case of the chrome problem, and for when it is blank and you don't even know one letter to type.
    
    (happy for this to be ignored if ctrl-space isn't easy.)
    
    > advanced mode
    
    details to follow
    
    ---
    
    **other items**
    
    * the location display name is optional.  if blank brooklyn will use the id.  being blank should not block "next" enablement.  
    
    * also region is optional, jclouds will pick one
    
    * the "next" button does not enable until after i've focussed away from the last text box (we can live with this if not easy to change)



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197850295
  
    BTW:  the previous comment does not reflect my huge excitement at this PR!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197866283
  
    builds fine now, and works well as far as i've been able to test it.  some comments so far...
    
    technical:
    
    * most of the time autocomplete does not show, e.g. on minRam; is there a way to make it more obvious?
    
    cosmetic:
    
    * capitalization is inconsistent.  for titles/labels the pattern has  been "Location Name" (all words in initial caps, acronyms all caps) not "location name" or "Location name"
    * more help text is required; imagine a new user -- they won't know what to put for "location id"; could say "Give a label to identify this location. Typically this is lower case using hyphens and no spaces, such as my-openstack-ireland" and similarly for "name" ("Optionally provide a display name for this location, using capitals and spaces, such as 'My OpenStack (Ireland)'."), and "identity" / "credential" it isn't clear this is to log on to the cloud
    * how will a user know what BYON is?  (a circle icon giving popup help could work for this and the previous, if too much text is not wanted; alternatively we could call it "Manual IP Addresses")
    * the message about "Required information about your location" is cryptic and in fact wrong as many of the fields are not required; remove it altogether?
    * the "additional configuration" page is imposing; can we make it clear that there is no need to set anything, but if you want to put constraints or special login there are many config keys available (possibly with link to the website)
    
    conceptual:
    
    * I don't think `localhost` should be a top-level item.  it's only something advanced users should try.  extending an existing location is probably more important.  we could call that tab "Advanced" and within it a text field for `type` with autocomplete allowing `localhost` and any named locations the user has previously set up.
    
    a huge leap forward!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197986507
  
    @tbouron in that case let's ignore the autocomplete popup and the next enablement issues
    
    can't wait for this all to be angularized!  :)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-198308842
  
    fantastic -- merging.  minor tweaks to descriptions etc.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by tbouron <gi...@git.apache.org>.
Github user tbouron commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197925582
  
    Technical:
    - What is the issue with the autocomplete? Works ok after at least one character for me.
    
    Cosmetic:
    - Will change for all words in initial caps, acronyms all caps
    - Will provide helper texts
    - Same as above
    - Will remove the text
    - Buttons are enabled on this screen which makes it obvious that you don't need to do anything else. But I can change the subtitle from `Provisioning information about your location` to `Optional provisioning information about your location`
    
    Conceptual:
    - I disagree with that. Those 3 top level location types are taken from the [Brooklyn docs](https://brooklyn.apache.org/v/latest/ops/locations/index.html) to be consistent!



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by shartzel <gi...@git.apache.org>.
Github user shartzel commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-198190837
  
    sorry for the late reply; re: localhost, if I'm following, I believe I agree with what @ahgittin is saying. I understand the logic in remaining consistent with the top level cloud v byon v localhost, but I think it should be compressed away to one flow.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by tbouron <gi...@git.apache.org>.
Github user tbouron commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197866956
  
    Added the reference to `easy-autocomplete`, see my last commit


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by tbouron <gi...@git.apache.org>.
Github user tbouron commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-198286661
  
    @ahgittin Pushed latest changes. Hopefully it includes everything now.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by tbouron <gi...@git.apache.org>.
Github user tbouron commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197946011
  
    > maybe it's a huge time delay or my machine. for me it only popped up once and then vanished. other times i couldn't get anything to show.
    >
    > is it possible to have ctrl-space also trigger it, and put a hint that this is supported? that at least makes it consistent with composer and obvious that it is possible.
    
    ctrl + space to display the autocomplete? It does not work for me. The suggestions are displayed as soon a I type something in the field. If a type a `i`, it display this instantly
    ![screen shot 2016-03-17 at 15 53 15](https://cloud.githubusercontent.com/assets/2082759/13852072/83775fba-ec58-11e5-8378-d901d07a8a7c.png)
    I think that's an issue with your build.
    
    > i find button enablement a subtle clue not an obvious one. (disablement is an obvious indicator that i cannot proceed but if i'm taken to a screen i assume i'm supposed to do something there. the obvious button in this screen is Add configuration which is intimidating.)
    >
    > additionally i'd like us to more user-friendly less techie/jargony. the phrase provisioning information about your location whether optional or not isn't clear to me. also it's too general in many cases (because the previous screen gave a bunch of provisioning information) and wrong in others (specifying a loginUser is not provisioning information, it's information to connect to a provisioned machine).
    >
    > how about text such as: In many target locations, additional configuration may be supported. Enter any such options here. Autocomplete for some config options is available using Ctrl-Space. For information on available options consult the [LINK]Brooklyn docs. Alternatively you can skip this step.
    
    I'll change for your text.
    
    > the docs have evolved, and 5 years ago pre-vagrant even localhost was common. they should be updated, not this based on that. the menu options in the docs are better, with "named locations" as the second choice.
    >
    > localhost is useful for techies and debugging but not a casual user who increasingly we want to target, who is trying to deploy community blueprints for use. it is something that an advanced user who is comfortable with ssh localhost might do max once. clouds, byon, and named/extending otoh are things people do routinely.
    > 
    > (incidentally i think because localhost is available as a resolver you can specify it as a location in a yaml even if it isn't defined as a type. so i'm not even sure that most users would want to click that ever!)
    
    I then need to know what to do in details.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197849919
  
    The maven build fails -- same error reported by apache jenkins as on my machine -- due to:
    
    ```
    [ERROR - 2016-03-17T12:05:21.370Z] Session [85626510-ec38-11e5-968b-4b6a977c9118] - page.onError - msg: Error: Script error
    http://requirejs.org/docs/errors.html#scripterror
    
      phantomjs://platform/console++.js:263 in error
    [ERROR - 2016-03-17T12:05:21.370Z] Session [85626510-ec38-11e5-968b-4b6a977c9118] - page.onError - stack:
      onError (http://localhost:53270/src/js/libs/require.js:32)
      A (http://localhost:53270/src/js/libs/require.js:15)
      onScriptError (http://localhost:53270/src/js/libs/require.js:32)
    
      phantomjs://platform/console++.js:263 in error
    ```
    
    I'll test this in IDE but the above can be fixed in parallel.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] brooklyn-ui pull request: Location wizard

Posted by tbouron <gi...@git.apache.org>.
Github user tbouron commented on the pull request:

    https://github.com/apache/brooklyn-ui/pull/17#issuecomment-197967691
  
    > the "next" button does not enable until after i've focussed away from the last text box (we can live with this if not easy to change)
    Could fix it with Angular, don't know how to do it with the current stack. It was already complicated enough to have inter-dependency management between fields.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---