NovaCustom NS5x/7x 12th Gen 06.11.2023 - Release v1.7.1 review - Githubissues

Dasharo / dasharo-issues

The Dasharo issue tracker

https://dasharo.com/

24 stars 0 forks source link

NovaCustom NS5x/7x 12th Gen 06.11.2023 - Release v1.7.1 review #566

Open pietrushnic opened 11 months ago

pietrushnic commented 11 months ago

The problem you're addressing (if any)

Improvements of release deliverables.

Describe the solution you'd like

[ ] #567
[ ] continues documentation improvements, e.g., SOL which was added in v1.7.1 links to test procedure, which may not show the value which we deliver through that feature, we should switch our strategy from test description focused to user documentation focused - to solve this issue we should present at any future release that we have zero pointers to documentation description, but rather focus on extending description of feature for the user and test documentation is in OSFV Robot Framework scripts (maybe even generated automatically to publicly accessible form)
[ ] #568
[ ] #569
[ ] broken formatting of test steps in 31H
[ ] #570
[ ] Setup menu password configuration was not linked to correct section. It was linked to menu guides
[ ] Mixed links Better support for USB-PD power supplies is linked to Power delivery compatibility issue as well as the other way around - maybe we can generate a fixed section based on correctly titled issues from github?
[ ] Some issues were not closed despite being reported as fixed e.g. suspend mode - ideally, we should have test results coupled with GitHub issues somehow, so when we have some passing test, it is linked to issue and another way around, I'm pretty sure this can be automated to avoid problems, then the bot would post "fixed for {dasharo_supported_hardware} in {release_version}"
[ ] Some issues have had zero comments for more than a year, still open despite the fact that we claim those were fixed, e.g. here
[ ] Maybe it is worth releasing the RC version to those who are willing to test, e.g. here
[ ] Issues naming consistency e.g. ... (Windows 11), or ... on Windows 11, or in Ubuntu 22.04 etc.
[x] Openness score: why don't we show proprietary BIOS stats? https://docs.dasharo.com/variants/novacustom_ns5x_adl/openness-score/#cbfs-coreboot

Where is the value to a user, and who might that user be?

Less confusion better consistency. Those improvements are needed not only fro users, but also for Dasharo Team.

Describe alternatives you've considered

No response

Additional context

No response

macpijan commented 11 months ago

@pietrushnic I created some dedicated issues for bigger tasks and fixed some links on your side.

macpijan commented 11 months ago

we should switch our strategy from test description focused to user documentation focused - to solve this issue we should present at any future release that we have zero pointers to documentation description, but rather focus on extending description of feature for the user and test documentation is in OSFV Robot Framework scripts (maybe even generated automatically to publicly accessible form)

This is exactly what I have in mind. I would like to remove the manual documentation procedures entirely, and replace it with ones generated from OSFV. Partly that is why we do not invest in improvements of these a lot right now. But I agree, instead we could create feature documention.

macpijan commented 11 months ago

Setup menu password configuration was not linked to correct section. It was linked to menu guides

It makes it more difficult to link, if it is not in the menu on the right side. I changed that some time ago, and it is changed back. I would need to see why.

macpijan commented 11 months ago

Issues naming consistency e.g. ... (Windows 11), or ... on Windows 11, or in Ubuntu 22.04 etc.

Any idea how to solve that? Issue naming guidelines?

macpijan commented 11 months ago

Openness score: why don't we show proprietary BIOS stats? https://docs.dasharo.com/variants/novacustom_ns5x_adl/openness-score/#cbfs-coreboot

The only supported firmware on these NovaCustom devices is Dasharo. We have not used proprietary firmware for the long time, I am not even sure which version we should use. We do not have this automated to generate such a report for proprietary firmware right now.

pietrushnic commented 11 months ago

Any idea how to solve that? Issue naming guidelines?

We have very little management activity regarding bug scrubbing and bug management. If we do not spend time on that activity, we don't learn. I don't think guidelines for bug submitters will work because if we want to use bug titles in release notes, we have to care about their quality, and quality checks/improvements can be done only by someone relatively experienced. We may have guidelines for our managers or experienced individual contributors. The key point to be aware of is that those bug titles will be in the release notes. Here we just lack consistency but sometimes we lack title quality. Let's be consistent when we report on what OS problems appear. Or maybe add labels.

pietrushnic commented 11 months ago

The only supported firmware on these NovaCustom devices is Dasharo. We have not used proprietary firmware for the long time, I am not even sure which version we should use. We do not have this automated to generate such a report for proprietary firmware right now.

Ok, there is no alternative, so there is no reference point. In the long run, we should consider some comparisons because the user has a hard time judging what that number means in the current state of the art for open-source firmware market.