1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00

docs(4.3): update tech debt section.

This commit is contained in:
Thomas Heartman 2021-12-14 14:23:39 +01:00
parent d59d2f141e
commit 5653331eea
3 changed files with 3 additions and 3 deletions

View File

@ -18,13 +18,13 @@ A toggle being (potentially) stale, does not affect how it performs in your appl
In order to assist with removing unused feature toggles, Unleash provides a technical debt dashboard in the management-ui. You can find it by clicking on “Advanced” in the top-line menu then choose _Reporting_ in the dropdown menu.
![Technical debt](/img/reporting.png)
![Three UI elements describing the health rating of the project. The first card has info on the project, including its name. The second is the \"report card\", containing the project's overall health rating, a toggle report, and potential actions. The last card is a list of all the project's toggles with data on when it was last seen, when it was created, when it expired, its status and a report.](/img/reporting.png)
The dasboard includes a health report card, and a list of toggles that can be filtrated on different parameters.
### Report card {#report-card}
![Report card](/img/reportcard.png)
![The project's health report card. It lists the project's health rating and when it was last updated; a toggle report containing the number of active toggles in the project; and potential actions, in this case asking the user to review potentially stale toggles.](/img/reportcard.png)
The report card includes some statistics of your application. It lists the overall amount of your active toggles, the overall amount of stale toggles, and lastly, the toggles that Unleash believes should be stale. This calculation is performed on the basis of toggle types:
@ -46,6 +46,6 @@ The health rating updates once every hour, so there may be some lag if you have
### Toggle list {#toggle-list}
![Toggle list](/img/togglelist.png)
![A table of the toggles in the current project with their health reports. The table has the following columns: name, last seen, created, expired, status, and report.](/img/togglelist.png)
The toggle list gives an overview over all of your toggles and their status. In this list you can sort the toggles by their name, last seen, created, expired, status and report. This will allow you to quickly get an overview over which toggles may be worth deprecating and removing from the code.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 568 KiB

After

Width:  |  Height:  |  Size: 226 KiB