mirror of
https://github.com/Dasharo/docs.git
synced 2026-06-13 10:16:57 -07:00
workflows: Create SEO jobs for broken links
Signed-off-by: Norbert Kamiński <norbert.kaminski@3mdeb.com>
This commit is contained in:
Norbert Kamiński
@@ -0,0 +1,22 @@
|
||||
---
|
||||
name: SEO CI
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
|
||||
jobs:
|
||||
linkChecker:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Link Checker
|
||||
id: lychee
|
||||
uses: lycheeverse/lychee-action@v1.8.0
|
||||
with:
|
||||
fail: true
|
||||
args: --max-redirects 10 -a 403,500,503 .
|
||||
@@ -0,0 +1,7 @@
|
||||
https://www.paypal.com/cgi-bin/webscr
|
||||
https://twitter.com/*
|
||||
89eBqUwoCpnPoUKD367kJm3Gsw639EUSdG3xwUyQmDroKHWHPyhYmJ63uP41ArHfPsBihNFTYjASpRUGaeSyp3JS9BmtjpQ
|
||||
pkt1qyv4gmnvvg2vfyj89e63thzj68jf2y9k7ssee7
|
||||
1GUm6FF7Fon6Umrt5CSi3AxxYg8dM2NKvV
|
||||
https://reproducible-builds.org/
|
||||
https://www.linkedin.com/company/*
|
||||
@@ -7,7 +7,7 @@ a running system.
|
||||
|
||||
## System information
|
||||
|
||||
One may use [Dasharo Tools Suite HCL report](../../dasharo-tools-suite/documentation#hcl-report)
|
||||
One may use [Dasharo Tools Suite HCL report](https://docs.dasharo.com/dasharo-tools-suite/documentation#hcl-report)
|
||||
or [fwdump-docker image](https://github.com/3mdeb/fwdump-docker) to
|
||||
gather all the hardware configuration information from a running system. The
|
||||
usage of the tools should result in an archive containing various logs from the
|
||||
@@ -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](../../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:
|
||||
|
||||
@@ -22,5 +22,5 @@ issues](https://github.com/Dasharo/dasharo-issues/issues?q=is%3Aopen+is%3Aissue+
|
||||
|
||||
And if you have already used this system and would be interested in supporting
|
||||
the project, please check how to get [Supporters
|
||||
Entrance](../../osf-trivia-list/dts/#what-is-dasharo-tools-suite-supporters-entrance),
|
||||
Entrance](https://docs.dasharo.com/osf-trivia-list/dts/#what-is-dasharo-tools-suite-supporters-entrance),
|
||||
which ensures delivery of Dasharo firmware updates.
|
||||
|
||||
@@ -37,7 +37,7 @@ Dasharo ([major_framework]+[minor_framework]) v[version]
|
||||
primary framework, e.g. a coreboot payload. May not always be used, e.g. if
|
||||
`edk2` is used as the primary framework.
|
||||
- `version` means version according to official
|
||||
[Dasharo Versioning](../versioning) documentation.
|
||||
[Dasharo Versioning](versioning.md) documentation.
|
||||
|
||||
_For [TianoCore UEFIPayloadPkg](https://github.com/Dasharo/edk2/tree/dasharo/UefiPayloadPkg),
|
||||
we use the simpler and more recognizable UEFI name._
|
||||
|
||||
+2
-2
@@ -10,8 +10,8 @@ keep content added by us minimalistic.
|
||||
## Embedded Firmware
|
||||
|
||||
We use definition explained in first chapter of
|
||||
["Embedded Firmware Solutions"](https://www.apress.com/gp/book/9781484200711) 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
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Commercial inquiries
|
||||
|
||||
If you have any questions about our services, feel free to contact us using
|
||||
[Dasharo contact form](https://dasharo.com/pages/contact.html) or
|
||||
[Dasharo contact form](https://www.dasharo.com/pages/contact/) or
|
||||
[3mdeb contact form](https://3mdeb.com/contact/), or [book a call with us](https://calendly.com/3mdeb/consulting-remote-meeting).
|
||||
|
||||
@@ -19,14 +19,14 @@ 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](../../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/#how-to-get-dasharo-tools-suite-supporters-entrance).
|
||||
[Supporters Entrance](dts.md#how-to-get-dasharo-tools-suite-supporters-entrance).
|
||||
|
||||
## Why 3mdeb created Dasharo?
|
||||
|
||||
@@ -101,7 +101,7 @@ release notes directly to the customer and does not have to be publicly
|
||||
available.
|
||||
1. Every firmware produced by Dasharo Ecosystem use [Semantic Versioning
|
||||
2.0.0](https://semver.org/) compatible versioning scheme. For details please
|
||||
check [description](../../dev-proc/versioning).
|
||||
check [description](https://docs.dasharo.com/dev-proc/versioning).
|
||||
1. Every firmware produced by Dasharo Ecosystem should use [Keep A Changelog
|
||||
1.0.0](https://keepachangelog.com/en/1.0.0/) compatible scheme as changelog
|
||||
format.
|
||||
@@ -129,7 +129,7 @@ Those microcontrollers and IP blocks typically require firmware blobs as well.
|
||||
Some of the blobs are clearly visible, some may be obfuscated and hidden inside
|
||||
the silicon or other firmware blobs (e.g. Intel Management Engine region
|
||||
contains multiple other blobs besides the ME firmware -
|
||||
[more about Intel ME blob](../me)).
|
||||
[more about Intel ME blob](me.md)).
|
||||
|
||||
So Dasharo's binary blob policy is as follows:
|
||||
|
||||
@@ -270,12 +270,13 @@ and binary blobs transmission, as well as recovery.
|
||||
|
||||
For more details about zero-touch initial deployment please read relevant
|
||||
DTS
|
||||
[documentation](../../dasharo-tools-suite/documentation/#dasharo-zero-touch-initial-deployment).
|
||||
[documentation](https://docs.dasharo.com/dasharo-tools-suite/documentation/#dasharo-zero-touch-initial-deployment).
|
||||
|
||||
### Dasharo Clean and Simple Code
|
||||
|
||||
Dasharo is an open-source distribution project with a simple code structure
|
||||
described in detail [here](../../../dev-proc/source-code-structure). While the
|
||||
described in detail
|
||||
[here](https://docs.dasharo.com/dev-proc/source-code-structure). While the
|
||||
project benefits from the simplicity of the coreboot source code, it is
|
||||
continuously researching and improving its development process and tools to
|
||||
provide a superior experience for developers. One example of this ongoing work
|
||||
@@ -283,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](../../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
|
||||
|
||||
@@ -479,11 +481,12 @@ 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](../../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/
|
||||
[dtsos]: ../dasharo-tools-suite/overview.md
|
||||
[lvfs]: https://fwupd.org/lvfs/docs/consulting
|
||||
[gerrit-review]: https://review.coreboot.org/c/homepage/+/63402
|
||||
[cb-distro]: https://doc.coreboot.org/distributions.html
|
||||
|
||||
@@ -14,21 +14,19 @@ Following sections explain how to deal with most common `flashrom` problem.
|
||||
|
||||
### How to install Dasharo flashrom fork ?
|
||||
|
||||
The following procedure is for advanced users familiar with source compilation
|
||||
and can resolve potential missing dependencies or other typical compilation
|
||||
problems. If you are unfamiliar with compilation from source, we recommend
|
||||
using Dasharo Tools Suite, a minimal Linux environment to deploy, update, and
|
||||
maintain firmware on Dasharo-supported devices. Please follow [DTS
|
||||
documentation](../../dasharo-tools-suite/overview). Otherwise, please follow
|
||||
the compilation procedure.
|
||||
* Install flashrom v1.1 or newer with your distribution's package manager if
|
||||
you don't have it installed yet. If your distro doesn't provide flashrom or
|
||||
provides an outdated one, you can build it yourself using
|
||||
[this instruction](https://www.flashrom.org/dev_guide/building_from_source.html).
|
||||
* Or compile recent version of flashrom:
|
||||
|
||||
If you need flashrom for Dasharo-supported hardware and for some reason you
|
||||
cannot use DTS, please consider the compilation of Dasharo [flashrom
|
||||
fork](https://github.com/Dasharo/flashrom/tree/dasharo-release).
|
||||
|
||||
For compilation details and related issues, please check flashrom
|
||||
[documentation](https://review.coreboot.org/plugins/gitiles/flashrom/+/refs/heads/master/README)
|
||||
and [community](https://www.flashrom.org/Contact).
|
||||
[documentation](https://review.coreboot.org/plugins/gitiles/flashrom/+/refs/heads/master/README.rst)
|
||||
and [community](https://www.flashrom.org/contact.html).
|
||||
|
||||
### Perform dry run to detect the problems early
|
||||
|
||||
@@ -157,7 +155,7 @@ Note: flashrom can never write if the flash chip isn't found automatically.
|
||||
|
||||
that means your flashrom version is incorrect. Follow the procedure of
|
||||
[building flashrom](#how-to-install-dasharo-flashrom-fork) or use
|
||||
[DTS](../../dasharo-tools-suite/overview).
|
||||
[DTS](../dasharo-tools-suite/overview.md).
|
||||
|
||||
### Chip write protection enabled
|
||||
|
||||
@@ -199,7 +197,7 @@ tools that can simplify the operation for the user -->
|
||||
It is always a good idea to backup the original BIOS of your hardware, before
|
||||
switching to open-source firmware.
|
||||
|
||||
* Boot [Dasharo Tools Suite](../../../dasharo-tools-suite/documentation#bootable-usb-stick)
|
||||
* Boot [Dasharo Tools Suite](https://docs.dasharo.com/dasharo-tools-suite/documentation#bootable-usb-stick)
|
||||
* Choose option 9) Shell.
|
||||
* Read content of SPI NOR flash:
|
||||
|
||||
|
||||
@@ -24,18 +24,18 @@ Please help us develop Dasharo influence on open-source firmware market and
|
||||
spread the word about it. There are multiple ways to do that:
|
||||
|
||||
* [Join Dasharo Matrix
|
||||
Community](../../ways-you-can-help-us/#join-dasharo-matrix-community) and
|
||||
Community](../ways-you-can-help-us.md#join-dasharo-matrix-community) and
|
||||
support other members of community
|
||||
* [Join Dasharo open-source firmware
|
||||
vPub](../../ways-you-can-help-us/#join-dasharo-open-source-firmware-vpub) or
|
||||
vPub](../ways-you-can-help-us.md#join-dasharo-open-source-firmware-vpub) or
|
||||
other related event organized by 3mdeb or Dasharo Team.
|
||||
* [Write a Google review](../../ways-you-can-help-us/#write-a-google-review)
|
||||
* [Write a Google review](../ways-you-can-help-us.md#write-a-google-review)
|
||||
* [Follow us on social
|
||||
media](../../ways-you-can-help-us/#follow-us-on-social-media) and help
|
||||
media](../ways-you-can-help-us.md#follow-us-on-social-media) and help
|
||||
spreading the word about Dasharo.
|
||||
* [Contribute](../../ways-you-can-help-us/#contribute-through-github)
|
||||
* [Contribute](../ways-you-can-help-us.md#contribute-through-github)
|
||||
documentation, test results, [Dasharo Hardware Compatibility List
|
||||
Reports](../../../dasharo-tools-suite/documentation/#hcl-report)
|
||||
Reports](https://docs.dasharo.com/dasharo-tools-suite/documentation/#hcl-report)
|
||||
|
||||
To get access to DTS SE you should [contact 3mdeb](mailto:leads@3mdeb.com) or
|
||||
[Dasharo Team](mailto:contact@dasharo.com) and prove your contribution
|
||||
@@ -44,7 +44,7 @@ would be glad to give you access to DTS SE for a year.
|
||||
|
||||
### I have more time than money and I can't code
|
||||
|
||||
Please [contribute](../../ways-you-can-help-us/#contribute-through-github)
|
||||
Please [contribute](../ways-you-can-help-us.md#contribute-through-github)
|
||||
ideas for new features, review documentation and help testing bug fixes.
|
||||
|
||||
If you would like to pursue that path please contact us on [Dasharo -
|
||||
@@ -57,7 +57,7 @@ SE updates.
|
||||
|
||||
### I have more money than time
|
||||
|
||||
Please [donate](../../ways-you-can-help-us/#donate-money) using one of
|
||||
Please [donate](../ways-you-can-help-us.md#donate-money) using one of
|
||||
available methods and contact [3mdeb](mailto:leads@3mdeb.com) or [Dasharo
|
||||
Team](mailto:contact@dasharo.com) to let us know about your donation. Minimal
|
||||
donating to access DTS SE with one year update support is 60EUR.
|
||||
|
||||
@@ -52,7 +52,7 @@ transparent validation, privacy-respecting implementation, liberty for the
|
||||
owners, and trustworthiness for all. More details can be found here [\[7\]][7].
|
||||
|
||||
[1]: https://github.com/coreboot/coreboot
|
||||
[2]: https://docs.dasharo.com/variants/msi_z690/overview/
|
||||
[2]: https://docs.dasharo.com/unified/msi/overview/
|
||||
[3]: https://docs.dasharo.com/variants/dell_optiplex/overview/
|
||||
[4]: https://github.com/tianocore/edk2
|
||||
[5]: https://github.com/fwupd/fwupd
|
||||
|
||||
@@ -11,7 +11,7 @@ The below table contains information about all elements which are needed to
|
||||
create the testing stand.
|
||||
|
||||
* MSI PRO Z690-A platform
|
||||
* [RTE v1.1.0](https://3mdeb.com/shop/open-source-hardware/open-source-hardware-3mdeb/rte/)
|
||||
* [RTE v1.1.0](https://shop.3mdeb.com/shop/open-source-hardware/open-source-hardware-3mdeb/rte/)
|
||||
* Sonoff S20 type E
|
||||
* 4x standard female-female connection wire 2.54 mm raster
|
||||
* 7x standard female-female connection wire 2.54/2.00 mm raster
|
||||
@@ -32,7 +32,7 @@ documentation.
|
||||
### RTE
|
||||
|
||||
RTE (acronym: Remote Testing Environment) should be prepared in accordance with
|
||||
[Quick start guide](../../rte/v1.1.0/quick-start-guide) documentation dedicated
|
||||
[Quick start guide](../rte/v1.1.0/quick-start-guide.md) documentation dedicated
|
||||
to the device.
|
||||
|
||||
### Sonoff
|
||||
@@ -282,7 +282,7 @@ The following sections describe how to use all of the enabled features:
|
||||
### Serial connection
|
||||
|
||||
The method of setting and using serial connection is described in the
|
||||
[Serial connection guide](../../rte/v1.1.0/serial-port-connection-guide).
|
||||
[Serial connection guide](../rte/v1.1.0/serial-port-connection-guide.md).
|
||||
|
||||
### Power supply controlling
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ The below table contains information about all elements which are needed to
|
||||
create the testing stand.
|
||||
|
||||
* MSI PRO Z790-P platform
|
||||
* [RTE v1.1.0](https://3mdeb.com/shop/open-source-hardware/open-source-hardware-3mdeb/rte/)
|
||||
* [RTE v1.1.0](https://shop.3mdeb.com/shop/open-source-hardware/open-source-hardware-3mdeb/rte/)
|
||||
* Sonoff S20 type E
|
||||
* 4x standard female-female connection wire 2.54 mm raster
|
||||
* 7x standard female-female connection wire 2.54/2.00 mm raster
|
||||
@@ -26,13 +26,13 @@ components of the laboratory stand.
|
||||
### MSI PRO Z790-P
|
||||
|
||||
MSI PRO Z790-P platform should be prepared in accordance with the
|
||||
[Motherboard assembly](presale-assembly-and-validation.md#motherboard-assembly-only)
|
||||
[Motherboard assembly](../msi-z690/presale-assembly-and-validation.md#motherboard-assembly-only)
|
||||
documentation.
|
||||
|
||||
### RTE
|
||||
|
||||
RTE (acronym: Remote Testing Environment) should be prepared in accordance with
|
||||
[Quick start guide](../../rte/v1.1.0/quick-start-guide) documentation dedicated
|
||||
[Quick start guide](../rte/v1.1.0/quick-start-guide.md) documentation dedicated
|
||||
to the device.
|
||||
|
||||
### Sonoff
|
||||
@@ -282,7 +282,7 @@ The following sections describe how to use all of the enabled features:
|
||||
### Serial connection
|
||||
|
||||
The method of setting and using serial connection is described in the
|
||||
[Serial connection guide](../../rte/v1.1.0/serial-port-connection-guide).
|
||||
[Serial connection guide](../rte/v1.1.0/serial-port-connection-guide.md).
|
||||
|
||||
### Power supply controlling
|
||||
|
||||
|
||||
@@ -203,4 +203,4 @@ display with 1920x1080 resolution.
|
||||
|
||||
## Where to buy?
|
||||
|
||||
The PiKVM is available in our [online shop](https://3mdeb.com/shop/open-source-hardware/pikvm/).
|
||||
The PiKVM is available in our [online shop](https://shop.3mdeb.com/shop/open-source-hardware/pikvm/).
|
||||
|
||||
@@ -20,7 +20,7 @@ applications are:
|
||||
|
||||
## Where to buy?
|
||||
|
||||
**RTE** can be also bought in our [3mdeb shop](https://3mdeb.com/shop/open-source-hardware/open-source-hardware-3mdeb/rte/).
|
||||
**RTE** can be also bought in our [3mdeb shop](https://shop.3mdeb.com/shop/open-source-hardware/open-source-hardware-3mdeb/rte/).
|
||||
|
||||
Full Remote Testing Environment set includes:
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ RTE.
|
||||
|
||||
|
||||
1. Connect the cables coming out from the WSON8 probe to the
|
||||
[SPI header](../specification/) according to the pictures and table
|
||||
[SPI header](specification.md) according to the pictures and table
|
||||
below.
|
||||
|
||||
- Top view of flash chip:
|
||||
|
||||
@@ -8,7 +8,7 @@ common preparation of RTE without listed functions.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
* [RTE board](https://3mdeb.com/shop/open-source-hardware/open-source-hardware-3mdeb/rte/)
|
||||
* [RTE board](https://shop.3mdeb.com/shop/open-source-hardware/open-source-hardware-3mdeb/rte/)
|
||||
(this document is based on v1.1.0)
|
||||
* Micro-USB 5V 2.5A power supply
|
||||
* Orange Pi
|
||||
@@ -48,8 +48,8 @@ common preparation of RTE without listed functions.
|
||||
1. Insert SD card into Orange Pi.
|
||||
1. Connect the ethernet cable to Orange Pi.
|
||||
1. Plug the USB-UART converter into your computer and connect its pins with
|
||||
[RTE J2 Header](../specification/#uart0-header). (you may need a
|
||||
USB extension cable)
|
||||
[RTE J2 Header](specification.md#uart0-header).
|
||||
(you may need a USB extension cable)
|
||||
|
||||
|UART Converter | RTE J2 Header|
|
||||
|:-------------:|:------------:|
|
||||
|
||||
@@ -18,7 +18,7 @@ another device.
|
||||
## Setting serial connection
|
||||
|
||||
1. Put the two jumpers on
|
||||
[RTE J16 Header](../specification/#uart-output-select-header):
|
||||
[RTE J16 Header](./specification.md#uart-output-select-header):
|
||||
|
||||
1. For the RS232 port, they join COM and RS232 rows both on RX and TX
|
||||
columns.
|
||||
|
||||
@@ -14,5 +14,5 @@ adapter][shop1], like in the [muxPi product][shop2].
|
||||
|
||||
|
||||
|
||||
[shop1]: https://3mdeb.com/shop/open-source-hardware/open-source-hardware-3mdeb/muxsd-adapter/
|
||||
[shop2]: https://3mdeb.com/shop/open-source-hardware/open-source-hardware-3mdeb/muxpi/
|
||||
[shop1]: https://shop.3mdeb.com/shop/open-source-hardware/open-source-hardware-3mdeb/muxsd-adapter/
|
||||
[shop2]: https://shop.3mdeb.com/shop/open-source-hardware/open-source-hardware-3mdeb/muxpi/
|
||||
|
||||
@@ -20,7 +20,7 @@ LED positions are showed in the image below.
|
||||
|
||||
|
||||
|
||||
<center>Source: [wiki.tizen.org](https://wiki.tizen.org/images/thumb/3/3f/SDWire-leds.jpg/300px-SDWire-leds.jpg)</center>
|
||||
<center>Source: [wiki.tizen.org](https://wiki.tizen.org/File:SDWire-leds.png)</center>
|
||||
|
||||
## PCB elements and scheme
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user