codecharta icon indicating copy to clipboard operation
codecharta copied to clipboard

Improve custom configs

Open BridgeAR opened this issue 3 years ago • 10 comments

Feature request

Description

As a user, I want custom configs to be easily understandable and easy to use so that I do not have to invest a lot of time using them.

Acceptance criteria

Please address the tasks (when in makes sense) in separate PRs to deliver value to the customer in small interations.

Minimum set before releasing the feature as stable:

  • [x] Remove notification when removing entries (just remove the entry by collapsing the list)
  • [x] "AI" entries should not be kept in the local storage. They are recalculated as soon as the map is loaded anyway. As discussed here, this will resolve #2435 and #2436.
  • [x] Do not close Custom Config menu after deleting a config.
  • [x] Do not show non-matching entries by default! Only list matching entries for the loaded maps. All others should be in a separate category.
  • [x] Rename everything related to custom configs/map to "Custom view"
  • [x ] Separate applicable and not-applicable entries.
  • [x] Add a "Show not-applicable entries" button below the list of applicable views and hide those by default.
  • [x] Add a subtitle in the Custom Views Modal to explain in one sentence for what the User can use it (e.g. Store your current Settings/Configuration, Download and Import them.). Add a link to the docs for more information.
  • [ ] Partially applicable entries (only a single map is loaded and there's a custom view for that map in multiple mode in combination with another map) count as applicable. (WIP by @Hall-Ma, #3090)
  • [ ] Partially applicable entries should be clickable but greyed out. While hovering over those, show what is missing to apply that custom view (e.g. map X is not loaded;map X is loaded in standard mode, but config is created for delta mode). On click, the config should still be applied, although it is greyed out. (WIP by @Hall-Ma, #3090)
  • [ ] Add icons/names/descriptions of metrics (area: rloc, height: foo, color: bar) and mode (single,multiple,delta) below the custom view name.
  • [ ] "Somehow" show the used colors (at least if they deviate from the default [green, yellow, red]) in the view
  • [ ] Add a search bar that allows to search for custom configs by name, metric, mode, groupname or similar parts. Use e.g., "🔎 Custom views..." as default text that is hidden on focus. Provide a "X" button to clear the input of the search field. (It should be a simple search field that filters the Custom Views in the list on keystroke)
  • [ ] Allow editing a custom view name by double clicking on the name. This makes the name editable. Safe the new name on unfocus.
  • [ ] Show a checkbox next to the entries while hovering over the entry. If at least a single checkbox is activated, show a action button with which the user may delete or download the corresponding entries.
  • [ ] Also show a checkbox "somewhere" next to the action button (no matter if anything is yet clicked upon or not) that allows to (de-)select all visible entries.

Tasks to release the feature as a stable one:


  • [x] Mark custom configs as stable (should be shown also when experimental mode is disabled)
  • [ ] Add a How To article in our documentation. Describe how to use it, how to Download/Import/Share custom configs. Describe how and why it is replacing the download button.
  • [ ] Show a deprecation warning in the changelog that the download button is going to be removed soon. Link to the How To article.
  • [x] Show deprecation warning in the "Export File" modal when clicking on the download button that the download functionality is going to be removed soon and that the Custom Views feature can be used instead. Link to the How To article to provide more information.
  • [x] Add a nice „NEW“ Feature Sticker in the ribbon bar.
  • [x] Grey out the download button, but it should still be clickable.
  • [ ] Create a GitHub issue to remove the download button (do not do that now) or to open the Custom Views Modal on Click instead.

Tasks for next iteration (I will move them to a new issue).

  • [ ] Group entries automatically on insertion.
  • [ ] Extend Action Button logic for groups (download, delete selected ones).
  • [ ] Allow to change the custom view order of groups and individual entries with drag and drop.
  • [ ] Auto delete empty groups (this happens by deleting individual entries or by moving the last entry out of a group).
  • [ ] Allow to merge two groups by dragging an existing group on top of another one (and show a hovering effect for the hovered group).
  • [ ] If all maps are uploaded, that are required by a custom config with delta mode, and the users is in the multiple mode, then this config should also be applicable. When activating this config, the mode should change to delta. The text "This View is partially applicable ..." should also be adjusted.
  • [ ] Bug: Activating a Custom Config for two maps in delta mode should respect the order of reference and comparison file (currently it is not considered).

  • [ ] TBD: Improve the import functionality and use a new input window for this. Concrete behavior requires further definition.
  • [ ] Resolve https://github.com/MaibornWolff/codecharta/issues/940 as cleanup after removing the download button

BridgeAR avatar Nov 09 '21 09:11 BridgeAR

Duplicate: #2462

ce-bo avatar Nov 09 '21 09:11 ce-bo

@ce-bo the mentioned issue has no specific description how to improve the situation.

BridgeAR avatar Nov 09 '21 20:11 BridgeAR

Related #1548

BridgeAR avatar Nov 15 '21 22:11 BridgeAR

@BridgeAR What was meant by Highlight matching entries for the currently loaded mode (single, multiple, diff)?

ce-bo avatar Jan 05 '22 15:01 ce-bo

@ce-bo I meant something like adding a small indicator below the entry that outlines the mode (next to e.g., the used metrics).

Something along the lines of (it should be styled appropriately and this is just a random box I found right now): image

BridgeAR avatar Jan 05 '22 17:01 BridgeAR

Here are the design suggestions we worked on in the workshop.

SavedViewsVersions.png

Christian-Eberhard avatar Feb 14 '22 11:02 Christian-Eberhard

This is currently blocked by a migration of the following components:

  • Download button
  • Upload Button
  • List view
  • Sublist view

BridgeAR avatar Mar 18 '22 10:03 BridgeAR

This is currently blocked by a migration of the following components:

  • Download button
  • Upload Button
  • List view
  • Sublist view

@shaman-apprentice @Hall-Ma Are the components already migrated?

ce-bo avatar Jun 03 '22 08:06 ce-bo

@ce-bo It's done.

Hall-Ma avatar Jun 03 '22 09:06 Hall-Ma

To deliver the CustomViews Feature as a stable one faster, we should prioritize the open tasks. I think not all are really needed to work with it productively. So before you start, please let us first discuss it.

ce-bo avatar Sep 23 '22 14:09 ce-bo

@Hall-Ma I changed the priority of the remaining sub tasks. Let's continue with "Tasks to release the feature as a stable one:" :-)

ce-bo avatar Nov 23 '22 14:11 ce-bo

Follow up issues to address further improvements: #3155 and #3156

ce-bo avatar Nov 29 '22 14:11 ce-bo