fuel-dev team mailing list archive

[Meg McRoberts <mmcroberts@xxxxxxxxxxxx>]

Meanwhile, we can work to improve the documentation in this regard.  It's
always a delicate balance -- we don't want
to over-complicate the process of getting started, but we also want to make
it easy to access all the information the user
needs to be successful.

I am trying to put the most essential instructions on the pages in the User
Guide (http://docs.mirantis.com/openstack/fuel/master/user-guide.html)
that step people through the process of creating and configuring their
OpenStack environments, with links to other docs for more details:

- Planning Guide (
http://docs.mirantis.com/openstack/fuel/master/user-guide.html) for
  guidelines for choosing between different options
- Operations Guide (
http://docs.mirantis.com/openstack/fuel/master/operations.html) for more
complicated and advanced procedures
- Reference Architecture (
http://docs.mirantis.com/openstack/fuel/master/reference-architecture.html)
for architectural detail about different features
- Terminology Reference (
http://docs.mirantis.com/openstack/fuel/master/terminology.html) for short
articles that
  define different terms and link to other docs that have more information.

I think the structure is reasonable; the information provided needs a lot
of work!  Feedback and input greatly appreciated.


On Mon, Jul 14, 2014 at 2:06 PM, Dmitriy Novakovskiy <
dnovakovskiy@xxxxxxxxxxxx> wrote:

> Sergii and Vitaly,
>
> Thanks for pointing out the blueprint. The concept looks interesting -
> will be great to see it implemented.
>
> But I would also offer you guys to use me and a bunch of other "external
> to Fuel" pairs of eyes as "guinea pigs" for UX testing.
>
> Why? IMO, the purpose of Web UI is to serve not so much a highly-skilled
> Mirantis engineer, but rather a low-to-medium-skilled Fuel downloader. And
> this downloader's primary goal is to get a working OpenStack cloud,
> hopefully - from first few attempts of "Deploy changes" -> "Delete
> environment" sequence :).
>
> *This brings me to 2 thoughts:*
>
> 1) Flexibility of configuration options on Web UI should not be excessive
> and overwhelming.
>
> While backend+CLI+documentation may support lots of super-flexible and
> highly customized scenarios - the Web UI should not have user spending too
> much time on figuring out all the endless powers that are out there (again
> - thinking about Web UI user's goals).
>
> 2) Web UI should rather present user with clear "silverlining" of making
> some choices (from a pre-defined "safe" list) and getting to a working cloud
>
> *Now, how this maps to previous discussion:*
>
> - I see a problem In the way how Networks and Wizard UIs are implemented
> right now (in 5.0)
>
> User has an opportunity to quickly add the nodes right after
> "Next-Next-Next" in Wizard, hit Deploy changes - and get a cloud w/ wrong
> (default) IP addresses and VLAN id's applied. He/she will simply skip doing
> any work on Networks tab unless he/she knows upfront it's needed. UI won't
> keep the user from making such mistake
>
> - In order to address this I currently see 2 options for discussion:
>
> A) Add an additional tab on Wizard sequence that will prompt user to
> specify Network settings - ranges for each network, VLAN ID's, etc. All the
> hints about what network does what (that I've suggested on a screenshot)
> should be shown there
>
> B) "Workaround" solution - after user presses "Finish" button in Wizard -
> show a message like "Now, please enter networking settings for your cloud"
> and switch the screen to Networks (instead of Nodes).
>
> Probably this will map to a new Fuel networking setup concepts as well.
> What do you think?
>
>
>
> ---
> Regards,
> Dmitriy
>
>
> On Mon, Jul 14, 2014 at 8:18 PM, Sergii Golovatiuk <
> sgolovatiuk@xxxxxxxxxxxx> wrote:
>
>> Hi,
>>
>> Vitaly, what you tell is absolutely right. Though, I think that errors
>> hints can overlap the default tips by manipulation with DOM using
>> JavaScript. I think if we add this, we'll improve UI as all hints will be
>> in place. Personally, I believe that tips and interactive help is much
>> better than documentation, though it should be updated also.
>>
>>
>> --
>> Best regards,
>> Sergii Golovatiuk,
>> Skype #golserge
>> IRC #holser
>>
>>
>> On Mon, Jul 14, 2014 at 7:29 PM, Vitaly Kramskikh <
>> vkramskikh@xxxxxxxxxxxx> wrote:
>>
>>> Hi,
>>>
>>> The space to the right from the input fields is taken by validation
>>> errors, so it could look like this:
>>>
>>>
>>>
>>> But I don't think we need to add these hints because in the near future
>>> we are going to implement advanced networking
>>> <https://blueprints.launchpad.net/fuel/+spec/advanced-networking> and
>>> there will be a set of predefined networks which can be renamed, new ones
>>> can be added, etc. So I think it is better to keep this stuff in the docs.
>>>
>>>
>>>
>>> 2014-07-12 13:06 GMT+04:00 Sergii Golovatiuk <sgolovatiuk@xxxxxxxxxxxx>:
>>>
>>> Hi Fuelers,
>>>>
>>>> Thank you Dmitry. It's a really good sample where we can improve UI.
>>>> That would be really nice to add hints to Fuel UI. Though documentation
>>>> should be updated also. I think the more hints we have the more user
>>>> friendly Fuel is.
>>>>
>>>>
>>>> --
>>>> Best regards,
>>>> Sergii Golovatiuk,
>>>> Skype #golserge
>>>> IRC #holser
>>>>
>>>>
>>>> On Sat, Jul 12, 2014 at 5:09 AM, Meg McRoberts <mmcroberts@xxxxxxxxxxxx
>>>> > wrote:
>>>>
>>>>> I could certainly add this text to the docs -- we have this absolutely
>>>>> hideous page in the docs:
>>>>>
>>>>> http://docs.mirantis.com/openstack/fuel/master/user-guide.html#network-settings
>>>>> and it would
>>>>> be really nice to break it up and give an explanation.  Although we do
>>>>> need to do it for all four
>>>>> topologies...
>>>>>
>>>>> We have a bit of information about Public and Floating IPs here -- it
>>>>> sounds like we need to
>>>>> augment that.
>>>>>
>>>>>
>>>>> On Fri, Jul 11, 2014 at 5:19 PM, Dmitriy Novakovskiy <
>>>>> dnovakovskiy@xxxxxxxxxxxx> wrote:
>>>>>
>>>>>> Hi Fuelers,
>>>>>>
>>>>>> Following the previous thread I've started - I took some notes from
>>>>>> the explanations that I've got around different ranges on Networks tab and
>>>>>> came up with the attached sketch. Some were challenging for me to
>>>>>> understand w/o a hint - Public, Internal. Probably someone who's completely
>>>>>> new to OpenStack context will struggle significantly, especially if he/she
>>>>>> is as lazy as I am and likes to figure out things by trying.
>>>>>>
>>>>>> Plz let me know if you think something like this might work for Fuel
>>>>>> UI. Straight ahead it looks like overloaed with text, maybe hiding it
>>>>>> behind "Show hint" link would make sense
>>>>>>
>>>>>> ---
>>>>>> Regards,
>>>>>> Dmitriy
>>>>>>
>>>>>> --
>>>>>> Mailing list: https://launchpad.net/~fuel-dev
>>>>>> Post to     : fuel-dev@xxxxxxxxxxxxxxxxxxx
>>>>>> Unsubscribe : https://launchpad.net/~fuel-dev
>>>>>> More help   : https://help.launchpad.net/ListHelp
>>>>>>
>>>>>>
>>>>>
>>>>> --
>>>>> Mailing list: https://launchpad.net/~fuel-dev
>>>>> Post to     : fuel-dev@xxxxxxxxxxxxxxxxxxx
>>>>> Unsubscribe : https://launchpad.net/~fuel-dev
>>>>> More help   : https://help.launchpad.net/ListHelp
>>>>>
>>>>>
>>>>
>>>> --
>>>> Mailing list: https://launchpad.net/~fuel-dev
>>>> Post to     : fuel-dev@xxxxxxxxxxxxxxxxxxx
>>>> Unsubscribe : https://launchpad.net/~fuel-dev
>>>> More help   : https://help.launchpad.net/ListHelp
>>>>
>>>>
>>>
>>>
>>> --
>>> Vitaly Kramskikh,
>>> Software Engineer,
>>> Mirantis, Inc.
>>>
>>
>>
>> --
>> Mailing list: https://launchpad.net/~fuel-dev
>> Post to     : fuel-dev@xxxxxxxxxxxxxxxxxxx
>> Unsubscribe : https://launchpad.net/~fuel-dev
>> More help   : https://help.launchpad.net/ListHelp
>>
>>
>
> --
> Mailing list: https://launchpad.net/~fuel-dev
> Post to     : fuel-dev@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~fuel-dev
> More help   : https://help.launchpad.net/ListHelp
>
>