From cdc0832af52fc87296491dd63ff5b7e7bc7a85e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Norbert=20Kami=C5=84ski?= Date: Tue, 25 Jul 2023 01:39:30 +0200 Subject: [PATCH] docs: Fix md styles MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Norbert Kamiński --- docs/common-coreboot-docs/dumping_logs.md | 4 ++-- docs/glossary.md | 4 ++-- docs/osf-trivia-list/dasharo.md | 18 ++++++++++-------- docs/variants/asus_kgpe_d16/setup.md | 4 ++-- docs/variants/msi_z690/hcl.md | 4 ++-- .../initial-deployment.md | 8 ++++---- 6 files changed, 22 insertions(+), 20 deletions(-) diff --git a/docs/common-coreboot-docs/dumping_logs.md b/docs/common-coreboot-docs/dumping_logs.md index 8ec58b46cd2..1598652af93 100644 --- a/docs/common-coreboot-docs/dumping_logs.md +++ b/docs/common-coreboot-docs/dumping_logs.md @@ -24,8 +24,8 @@ with the firmware. This method requires Secure Boot to be disabled. Options to get `cbmem` utility: 1. Download precompiled utility from [3mdeb cloud](https://cloud.3mdeb.com/index.php/s/zTqkJQdNtJDo5Nd/download) -2. Use [Dasharo Tools Suite](https://docs.dasharo.com/dasharo-tools-suite/releases#v110) v1.1.0 or - newer which has `cbmem` utility built in. +2. Use [Dasharo Tools Suite](https://docs.dasharo.com/dasharo-tools-suite/releases#v110) + v1.1.0 or newer which has `cbmem` utility built in. 3. Compile `cbmem utility`. See procedure below. Short instruction how to compile and use `cbmem` on Ubuntu 22.04 live CD: diff --git a/docs/glossary.md b/docs/glossary.md index 89f2c93e813..705e1cb8247 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -10,8 +10,8 @@ keep content added by us minimalistic. ## Embedded Firmware We use definition explained in first chapter of -["Embedded Firmware Solutions"](https://link.springer.com/book/10.1007/978-1-4842-0070-4) book -by Jiming Sun, Marc Jones, Stefan Reinauer and Vincent Zimmer. +["Embedded Firmware Solutions"](https://link.springer.com/book/10.1007/978-1-4842-0070-4) +book by Jiming Sun, Marc Jones, Stefan Reinauer and Vincent Zimmer. Firmware is "layer of software between the hardware and the operating system (OS), with the main purpose to initialize and diff --git a/docs/osf-trivia-list/dasharo.md b/docs/osf-trivia-list/dasharo.md index 9af6105ecf5..5409b4f1acb 100644 --- a/docs/osf-trivia-list/dasharo.md +++ b/docs/osf-trivia-list/dasharo.md @@ -19,11 +19,11 @@ Dasharo is an open-source firmware distribution focusing on: Dasharo consists of [productized services](#dasharo-professional-support), set of [open-source repositories](https://github.com/orgs/Dasharo/repositories), -and [quality control](https://docs.dasharo.com/unified-test-documentation/overview/) which help to -provide scalable, modular, easy to combine open-source BIOS, UEFI, and firmware -solutions. It offers the components that are needed to develop and maintain a -high quality, and modular firmware, for the stability and security of your -platform. +and [quality control](https://docs.dasharo.com/unified-test-documentation/overview/) +which help to provide scalable, modular, easy to combine open-source BIOS, UEFI, +and firmware solutions. It offers the components that are needed to develop +and maintain a high quality, and modular firmware, for the stability and +security of your platform. For individuals Dasharo provides optional features in subscription model called [Supporters Entrance](dts.md#how-to-get-dasharo-tools-suite-supporters-entrance). @@ -284,7 +284,8 @@ is the improvements made to fork maintenance, currently being tracked in [this issue](https://github.com/Dasharo/dasharo-issues/issues/310) on the Dasharo GitHub repository. The project also explores the concept of a bootstrapable toolchain, discussed in the [build process -section](https://docs.dasharo.com/osf-trolling-list/build_process) of the project documentation. +section](https://docs.dasharo.com/osf-trolling-list/build_process) +of the project documentation. ### Dasharo Long Term Maintenance @@ -480,8 +481,9 @@ such a case, don't hesitate to contact us; we will see what we can do. However, the community member who requested support for the platform should also offer their help in validating the firmware and maintenance. That kind of request will be more than welcome from active community members. New members should -consider [ways to help us](https://docs.dasharo.com/ways-you-can-help-us/) to gain a reputation -that can lead to influencing Dasharo Community Supported roadmap. +consider [ways to help us](https://docs.dasharo.com/ways-you-can-help-us/) +to gain a reputation that can lead to influencing Dasharo Community Supported +roadmap. [coreboot-scope]: https://doc.coreboot.org/#scope-of-the-coreboot-project [dtsos]: ../dasharo-tools-suite/overview.md diff --git a/docs/variants/asus_kgpe_d16/setup.md b/docs/variants/asus_kgpe_d16/setup.md index 81ff33ee707..6254edb918f 100644 --- a/docs/variants/asus_kgpe_d16/setup.md +++ b/docs/variants/asus_kgpe_d16/setup.md @@ -98,8 +98,8 @@ option to connect a TPM, we use the header for that purpose. IMPORTANT: Use only TPM modules which match their pinout with the board's header! Using a spider web connection degrades the signal quality to the point where CPU cannot properly talk to TPM via LPC bus. Tested with -[PC Engines TPM module](https://shop.3mdeb.com/shop/modules/tpm-2-0/) and failed to -succeed this way. Designing and producing proper TPM header and/or reliable +[PC Engines TPM module](https://shop.3mdeb.com/shop/modules/tpm-2-0/) and failed +to succeed this way. Designing and producing proper TPM header and/or reliable adapter, could solve this problem. The [TwPM project](https://twpm.dasharo.com/) could help here in the future. diff --git a/docs/variants/msi_z690/hcl.md b/docs/variants/msi_z690/hcl.md index 900e973c502..092d4969dea 100644 --- a/docs/variants/msi_z690/hcl.md +++ b/docs/variants/msi_z690/hcl.md @@ -197,8 +197,8 @@ Maintainer documentation](https://docs.dasharo.com/dev-proc/hcl-maintainer). ## Contributing - Use [Dasharo Tools Suite HCL - report](https://docs.dasharo.com/dasharo-tools-suite/documentation/#hcl-report) to upload - report automatically. + report](https://docs.dasharo.com/dasharo-tools-suite/documentation/#hcl-report) + to upload report automatically. - Create new issue in [Dasharo issues repository](https://github.com/Dasharo/dasharo-issues/issues/new?assignees=&labels=P%3A+default%2C+T%3A+hcl&template=hcl-report.md&title=CPU+HCL+report+for+msi_z690). - Create PR directly to [Dasharo documentation diff --git a/docs/variants/supermicro_x11_lga1151_series/initial-deployment.md b/docs/variants/supermicro_x11_lga1151_series/initial-deployment.md index 5fe882b50aa..95eaa067bd8 100644 --- a/docs/variants/supermicro_x11_lga1151_series/initial-deployment.md +++ b/docs/variants/supermicro_x11_lga1151_series/initial-deployment.md @@ -14,10 +14,10 @@ following unofficial guides deviating in any way from the official instructions. If you have trouble with the installation process, ask for help on the official -[Dasharo chat channel](https://docs.dasharo.com/#community). There are almost always people -around willing to help with it. Before asking for help, make an attempt to -follow the guide on your own and then ask for help with anything you get stuck -on. +[Dasharo chat channel](https://docs.dasharo.com/#community). There are almost +always people around willing to help with it. Before asking for help, make an +attempt to follow the guide on your own and then ask for help with anything you +get stuck on. ## Hardware preparation