table freshness automation - #1309
Conversation
… table Signed-off-by: Oktawian Bieszke <oktawian.bieszke@3mdeb.com>
Add new pre-commit check for outdated openness score table Signed-off-by: Oktawian Bieszke <oktawian.bieszke@3mdeb.com>
| # Update this mapping when a device row is added/removed | ||
| # from the CSV, or when a platform's releases | ||
| # page is renamed or moved. | ||
| ROW_TO_RELEASE_PAGES = { |
There was a problem hiding this comment.
I know it's an early PR but the early feedback is: I do not like it very much. If we move some manual updates from tables into script, the net benefit is not that great. What's mising to automatically build such a table based on the documentation content?
There was a problem hiding this comment.
As for the table above, the script could match data from platforms overview.md pages to Firmware Update Method csv file, and generate such table on the run. Are there any other things, that caught your eye/could be done differently?
| os.path.join(os.path.dirname(NOVACUSTOM_OVERVIEW), link) | ||
| ).replace(os.sep, "/") | ||
|
|
||
| if "11th Gen" in label: |
There was a problem hiding this comment.
What if we add new NovaCustom device? We have to add it again manually here?
Each device-specific function in this script essentially suggests that maybe we can do something else in the documentation to make it more consistent.
We should at least coinsider it. If not possible right now for some reason, we should create an issue for further discussion.
There was a problem hiding this comment.
Each device-specific function in this script essentially suggests that maybe we can do something else in the documentation to make it more consistent.
We could add a new column to "docs/guides/firmware-update-method-support-table.csv" that wouldn't be rendered and would point to the actual release page of a platform. Then the whole scraping logic from this script would turn into just reading from the csv file.
277fb3b to
104313f
Compare
Signed-off-by: Oktawian Bieszke <oktawian.bieszke@3mdeb.com>
Signed-off-by: Oktawian Bieszke <oktawian.bieszke@3mdeb.com>
Signed-off-by: Oktawian Bieszke <oktawian.bieszke@3mdeb.com>
Signed-off-by: Oktawian Bieszke <oktawian.bieszke@3mdeb.com>
|
Automated Firmware Update Method Table generation |
| - [Firmware update via UEFI capsule update interface with LVFS support](https://docs.dasharo.com/kb/capsule-updates-overview/) | ||
| - [Capsule Update V1](https://docs.dasharo.com/kb/capsule-updates-overview/) | ||
| - [FWUPD support](https://docs.dasharo.com/kb/fwupd/) | ||
| - [LVFS support](https://docs.dasharo.com/kb/capsule-updates-overview/) |
There was a problem hiding this comment.
I don't think that's a good place to link here. Although I don't think we've got a documentation page that would say what's going on with LVFS.
It's so generic though that maybe we could link to some external documentation? We are not doing anything special with LVFS, you use it the same as always. Maybe it would make more sense to link to https://lvfs.readthedocs.io/en/latest/intro.html?
|
PR transfered |
3 participants
No description provided.