Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some details data not displayed in webapplication #220

Closed
bruderol opened this issue Jun 7, 2014 · 35 comments
Closed

Some details data not displayed in webapplication #220

bruderol opened this issue Jun 7, 2014 · 35 comments
Assignees
Labels
2 - Working Huboard Swimlane Working

Comments

@bruderol
Copy link
Member

bruderol commented Jun 7, 2014

Some data is not displayed in scenarioo webapplicaton that can be set and stored in the documentation files:

  • description and details of a branch
  • name and details of a build
  • description and details of a use case
  • number of pages in a scenario
  • more?
@bruderol bruderol added this to the Release-1.0-known-issues milestone Jun 7, 2014
@bruderol
Copy link
Member Author

bruderol commented Jun 8, 2014

I think we should add this details also as hideable "Show/Hide Details"-panel, in the same way as details for step and scenario, to the usecases-page (build and branch details) and to the scenarios-page (usecase details).

@bruderol
Copy link
Member Author

bruderol commented Jun 8, 2014

@adiherzog, @danielsuter and @forkch
What do you think about this idea?

@adiherzog
Copy link
Member

Sound reasonable, good plan. A user can still choose to hide these infos and we would remember this decision in local storage, as we already do it for the other metadata blocks.

@forkch
Copy link
Member

forkch commented Jun 8, 2014

sounds good. would be a good issue to get me back into client development so I'll assign it to me :-)

@forkch forkch self-assigned this Jun 8, 2014
@bruderol
Copy link
Member Author

bruderol commented Jun 9, 2014

@forkch
Cool ... one thing ... if you find time ... would be great if we could design this right side info blocks ("show metadata"/"hide metadata") equal on all pages (without having to copy paste it always). Therefore I think it is time to think about introducing some kind of directives (or other reusable ui components) for this, such that we can tweak this parts in one location. What do you think?

Also would be great if we could style the collapsable area with the show/hide button a little bit nicer ... maybe there are cool existing components for things like that?

@forkch
Copy link
Member

forkch commented Jun 9, 2014

yeah sure!

On Mon, Jun 9, 2014 at 12:46 PM, rodolpho notifications@github.com wrote:

@forkch https://github.com/forkch
Cool ... one thing ... if you find time ... would be great if we could
design this right side info blocks ("show metadata"/"hide metadata") equal
on all pages (without having to copy paste it always). Therefore I think it
is time to think about introducing some kind of directives (or other
reusable ui components) for this, such that we can tweak this parts in one
location. What do you think?

Also would be great if we could style the collapsable area with the
show/hide button a little bit nicer ... maybe there are cool existing
components for things like that?


Reply to this email directly or view it on GitHub
#220 (comment).

@bruderol
Copy link
Member Author

bruderol commented Jun 9, 2014

cool! Great! Looking forward to it ... 😄 👍

forkch added a commit that referenced this issue Jul 26, 2014
forkch added a commit that referenced this issue Jul 26, 2014
the state of each show-hide panel can be stored separately
forkch added a commit that referenced this issue Jul 26, 2014
added missing information of the usecases as show-hide details (collapsing of individual sections does not work yes)
forkch added a commit that referenced this issue Jul 26, 2014
added show-hide element for branch and build information in main usecases page
forkch added a commit that referenced this issue Jul 26, 2014
added basic information of branches and build (not collapsable yet), the details of branches and builds are missing, this resquires a refactoring of metadata.html (maybe turn it into a directive)
forkch added a commit that referenced this issue Jul 26, 2014
forkch added a commit that referenced this issue Jul 26, 2014
forkch added a commit that referenced this issue Jul 26, 2014
@forkch
Copy link
Member

forkch commented Jul 27, 2014

information is now displayed on the master branch version 1.0.4

but I would like to improve the code a bit..which I will do on the development branch

(and next time I do the whole process of finishing a hotfix by hand without git flow to get a feeling of what is happening #mergeingHell :-( )

@adiherzog adiherzog modified the milestones: 1.1 Release 1.1, 1.0 Release 1.0 Known Issues Jul 27, 2014
@adiherzog
Copy link
Member

Ok, great. I moved the issue to Release 1.1, which will be end of august.

If you are already working on this, I have two propositions:

  • On the overview page of one use case, show the description directly between the breadcrumbs and the list of scenarios. This is the most important information when looking at a use case, as it should give you a quick overview about what this use case does.
  • On the overview page of one scenario, show the description of its use case and the description of the scenario in the same place (between breadcrumbs and table). This should give the user a quick idea what this scenario is all about.
  • Do not show these descriptions in the metadata column again, as it would only be redundant.

@forkch What do you think about this idea?

PS: The idea is inspired by two events:

  • While in a meeting with a customer discussing about the future of Scenarioo, we realized that when one clicks on a use case, the description "gets lost".
  • A few days ago I looked through other living documentation tools. Concordion (http://concordion.org/) focuses on nice and concise layouts and also has a short description directly at the beginning of a feature.

@bruderol
Copy link
Member Author

I agree. But I think it is important to limit it only to the description field, because otherwise users will have to scroll down too much to get to the list of scenarios.

@bruderol
Copy link
Member Author

some feedback on what needs to be improved:

  1. on scenario overview page I see now two buttons "hide/show metadata"
  2. the button should be on the same row as the search field (right side of search field), currently it takes a new row (even on large screens) and therefore we loose space for nothing.

@forkch
Copy link
Member

forkch commented Jul 27, 2014

  1. whoops that's a merge error
  2. yes I see that, will try to improve this since this is now all a directive to hide/show details right of the content. This needs to be improved anyway

forkch added a commit that referenced this issue Jul 28, 2014
forkch added a commit that referenced this issue Jul 28, 2014
…and scenario page

Conflicts:
	scenarioo-client/app/scripts/controllers/scenario.js
forkch added a commit that referenced this issue Jul 28, 2014
Conflicts:
	scenarioo-client/app/styles/scenarioo.less
forkch added a commit that referenced this issue Jul 28, 2014
forkch added a commit that referenced this issue Jul 28, 2014
forkch added a commit that referenced this issue Jul 28, 2014
@forkch
Copy link
Member

forkch commented Jul 28, 2014

done (merged to master and develop) resulting in new version 1.0.5, please review and if there are no showblockers I will make a release on Github.

@bruderol bruderol modified the milestones: 1.1 Release 1.1, 1.0 Release 1.0 Known Issues Jul 28, 2014
@bruderol
Copy link
Member Author

moved it back to Release 1.0 known issues, because it is one ! ;-)
and also because obviously Ben is planning to release it as a bugfix release.

@bruderol
Copy link
Member Author

I like the new additional metadata areas. Cool. Did not find any bug so far. 😄 👍

What I do not like:
the descriptions right at the beginning of a page (not that I do not like this idea at all, but I do not like how it looks now) ... we should improve the styling and maybe add some information what this text means. Also I would like to see the description somehow connected (visualy) to the title (the name) of the usecase or scenario.

I think we should think about a new styling of page header (see also story #281 ), to display some context information (like the description, and the name of current object) more nicely without taking too much space.

AND I realy think we should do a UI design session together to discuss things like that once (already proposed that somewhere else ...).

@bruderol
Copy link
Member Author

Ok, finally found a minor bug on master branch (sorry):
When I hide the metadata on the home screen and change to a use case, also the metadata of the usecase is hidden and vice-versa. All other metadata areas are remembered separately (under different ID) whether they are hidden or not.
This should be corrected, such that a user that often wants to see metadata for usecases, but never wants to see metadata for build/branch, does not have to press on the button each time he changes between those two views.

One other minor thing (goes into the same discussion, mentioned already above): for build we now show the description in metadata area (probably also for branch?), for all other objects we do not show it there, but now in the title area instead, which is somehow inconsistent now ... I think we should make this consistent or at least define/discuss a clear concept when to display what where ... @adiherzog and @forkch what do you think about a design session to decide things like that?

@adiherzog
Copy link
Member

A design session is a good idea. I think what's currently a bit special is the different text sizes of the use case and the scenario text. And as soon as we add back page titles, the texts will not look so lost anymore.

@forkch Now if the metadata is expanded, the steps are still shown in the 3 column layout. Did you change that on purpose? And if some pages are expanded and some are collapsed, the two buttons are displayed stacked instead of next to each other.

collapse

@forkch
Copy link
Member

forkch commented Jul 29, 2014

thanks for the bugs :-) the double button is a browser cache issue
btw. regarding the cache problems there is an option in the developer options of chrome to disable cache WHEN the developer console is open. Really useful :-)

the other bug with the column layout is fixed

@forkch forkch closed this as completed Jul 29, 2014
@adiherzog
Copy link
Member

Thanks for the hint. That's a really useful option :-) And thanks for fixing the column issue.

But I still see the buttons issue. Go to http://54.88.202.24:8080/scenarioo-develop/#/scenario/Find%20Page/find_page_with_text_on_page_from_multiple_results?branch=example-branch&build=last%20successful and open one page while the other one is still collapsed. Don't you see them like me?

forkch added a commit that referenced this issue Jul 29, 2014
forkch added a commit that referenced this issue Jul 29, 2014
@forkch
Copy link
Member

forkch commented Jul 29, 2014

shame on me...
I did not realize that the problem was only a layout issue and the two buttons are actually correct and I checked only a scenario with only one page with multiple steps.

@forkch forkch reopened this Jul 29, 2014
@forkch forkch closed this as completed Jul 29, 2014
@adiherzog
Copy link
Member

No problem :-) Now it's fine. Thanks for fixing it!

@bruderol
Copy link
Member Author

Wow, what a cool "user story" 😄 👍
I think we realy understood the principle of user stories, because it says that a "user story is a promise to have a conversation" ... considering all this comments here ... I think we realy had a lot of conversation 😄
Thank you all!

@adiherzog
Copy link
Member

@forkch There's still a draft release not for 1.0.4. Should this be released as 1.0.7?

@forkch
Copy link
Member

forkch commented Aug 29, 2014

we will release this with the next big release. I deleted the draft and moved the issue to the 2.0.0 release notes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - Working Huboard Swimlane Working
Projects
None yet
Development

No branches or pull requests

3 participants