diff --git a/docs/src/firmware-action/get_started/01_repo.md b/docs/src/firmware-action/get_started/01_repo.md index 2cd48ce2..00245cc7 100644 --- a/docs/src/firmware-action/get_started/01_repo.md +++ b/docs/src/firmware-action/get_started/01_repo.md @@ -5,12 +5,12 @@ Start a new repository in GitHub and the clone it. ## Add coreboot as submodule -~~~admonish tip +```admonish tip Add git submodule with: -``` +~~~ git submodule add -``` ~~~ +``` Add [coreboot repository](https://review.coreboot.org/admin/repos/coreboot,general) as a submodule: ```bash @@ -32,7 +32,7 @@ Recursively initialize submodules. git submodule update --init --recursive ``` -~~~admonish warning +```admonish warning Recursively initializing all submodules in coreboot will take a moment. -~~~ +``` diff --git a/docs/src/firmware-action/get_started/02_coreboot_config.md b/docs/src/firmware-action/get_started/02_coreboot_config.md index b9d6b1c7..1d79d35b 100644 --- a/docs/src/firmware-action/get_started/02_coreboot_config.md +++ b/docs/src/firmware-action/get_started/02_coreboot_config.md @@ -1,4 +1,4 @@ -## Create a coreboot configuration file +# Create a coreboot configuration file Now we need to create a configuration file for coreboot. diff --git a/docs/src/firmware-action/get_started/03_json_config.md b/docs/src/firmware-action/get_started/03_json_config.md index 6b39b150..f6546237 100644 --- a/docs/src/firmware-action/get_started/03_json_config.md +++ b/docs/src/firmware-action/get_started/03_json_config.md @@ -8,19 +8,19 @@ This configuration file is for firmware-action, so that it knows what to do and ``` ~~~ -~~~admonish info +```admonish info Field `repo_path` is pointing to the location of our coreboot submodule. -~~~ +``` -~~~admonish info +```admonish info Field `defconfig_path` is pointing to the location of coreboot's configuration file. -~~~ +``` -~~~admonish info +```admonish info Firmware action can be used to compile other firmware too, and even combine multiple firmware projects (to a certain degree). For this reason the JSON configuration file is divided into categories (`coreboot`, `edk2`, etc). Each category can contain multiple entries. Entries can depend on each other, which allows you to combine them - you can have for example `coreboot` firmware with `edk2` payload. -~~~ +``` diff --git a/docs/src/firmware-action/get_started/05_run_firmware_action.md b/docs/src/firmware-action/get_started/05_run_firmware_action.md index 2f99ee2a..44a91c8c 100644 --- a/docs/src/firmware-action/get_started/05_run_firmware_action.md +++ b/docs/src/firmware-action/get_started/05_run_firmware_action.md @@ -10,9 +10,9 @@ Then it will proceed to download `coreboot` container (specified by `sdk_url` in If compilation is successful, a new directory `output-coreboot/` will be created (as specified by `output_dir` in JSON config) which will contain files (specified by `container_output_files` in JSON config) and possibly also directories (specified by `container_output_dirs` in JSON config). -~~~admonish info +```admonish info `container_output_dirs` and `container_output_files` are lists of directories and files to be extracted from the container once compilation finished successfully. These are then placed into `output_dir`. -~~~ +``` diff --git a/docs/src/firmware-action/get_started/06_run_in_ci.md b/docs/src/firmware-action/get_started/06_run_in_ci.md index a15ee8f2..7d768a70 100644 --- a/docs/src/firmware-action/get_started/06_run_in_ci.md +++ b/docs/src/firmware-action/get_started/06_run_in_ci.md @@ -1,12 +1,12 @@ -## Run firmware-action in GitHub CI +# Run firmware-action in GitHub CI Now that we have `firmware-action` working on local system. Let's set up CI. -~~~admonish example title=".github/workflows/example.yml" -```yaml +```admonish example title=".github/workflows/example.yml" +~~~yaml {{#include ../../firmware-action-example/.github/workflows/example.yml}} -``` ~~~ +``` Commit, push and watch. And that is it.