Example 2

Document writer <olivier.nicolas@insa-lyon.fr>
vxxx, 2022-xx-xx

Architecture

antora_example2/
├── antora-playbook.yml
└── system
    ├── antora.yml
    └── modules
        ├── module1
        │   ├── images
        │   │   └── image.jpg
        │   ├── nav.adoc
        │   ├── pages
        │   │   └── system1.adoc
        │   └── partials
        │       └── text.txt
        └── module2
            ├── nav.adoc
            └── pages
                └── system2.adoc

Files

antora_example2/antora-playbook.yml

site:
  title: Your Project
content:
  sources:
     - url: path_to_your_git_repository_folder
       start_path: Doc/Antora/example2/system

       branches: HEAD

runtime:
  fetch: true

ui:
 bundle:
    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
    snapshot: true

antora_example2/system/antora.yml

# Name will be mostly visible in the URL. Treat it as an indentifier.
# Tip: If you want to use the local preview scripts that come with this
# repository, please change this value in the site.yml file as well. (under
# site/start_page)
name: Your System

# Title will be visible on the page.
title: System overview - Example 2

# If you don't plan to have multiple versions of the docs (for example, to
# document multiple versions of some software), you can ignore this field.
# Otherwise, change "master" to a specific version.
version: master

# We encourage you to name the index page as "index.adoc". If you absolutely
# have to use a different name, please reflect it here. You can ignore this
# field otherwise.
##start_page: ROOT:pages/system.adoc

# This lists all the menu definitions of your component.
nav:
- modules/module1/nav.adoc
- modules/module2/nav.adoc

antora_example2/system/modules/module1/nav.adoc

* The system explained
** xref:system1.adoc[]

antora_example2/system/modules/module1/pages/system1.adoc

= Example1: System Overview
:source-highlighter: coderay

Document writer <olivier.nicolas@insa-lyon.fr>
v1.5, 2022-01-17

== The Flashing Process explained
=== The Linux Boot Process explained

Note: the terms initrd and initramfs are synonymous/interchangeable.

initramfs stands for INITial RAM File System

(Extracts from: https://www.kernel.org/doc/html/latest/admin-guide/initrd.html)

In a nutshell:


|===
||
a| When using initrd, the system typically boots as follows:

. the boot loader loads the kernel and the initial RAM disk
. the kernel converts initrd into a “normal” RAM disk and frees the memory used by initrd
. root device is mounted...
. init mounts the “real” root file system
. init places the root file system at the root directory
. init execs the /sbin/init on the new root filesystem, performing the usual boot sequence
. the initrd file system is removed
a| image::image.jpg[]
|===

//:https://operavps.com/wp-content/uploads/2020/06/boot-process-in-linux-in-6-level.jpg


=== The Flashing Process itself

Lorem Ipsum

antora_example2/system/modules/module2/nav.adoc

* The system explained - v2
** xref:system2.adoc[]

antora_example2/system/modules/module2/pages/system2.adoc

= Your system - Implementation v2
:source-highlighter: coderay

Document writer <charlie.chaplin@hollywood.com>
v2.0, 2022-10-25

== This would be the v2