aboutsummaryrefslogtreecommitdiffstats
path: root/content/tocs_guppy/architecture
diff options
context:
space:
mode:
Diffstat (limited to 'content/tocs_guppy/architecture')
-rw-r--r--content/tocs_guppy/architecture/fetched_files.yml140
-rw-r--r--content/tocs_guppy/architecture/toc_dev_en.yml106
2 files changed, 246 insertions, 0 deletions
diff --git a/content/tocs_guppy/architecture/fetched_files.yml b/content/tocs_guppy/architecture/fetched_files.yml
new file mode 100644
index 0000000..b57d5d2
--- /dev/null
+++ b/content/tocs_guppy/architecture/fetched_files.yml
@@ -0,0 +1,140 @@
+##############################################################################################################
+# GLOBAL DOCUMENT
+# <any REPOSITORY option>: global setting
+# repositories: array of objects with documents to fetchd
+#
+# REPOSITORY ENTRY:
+# -
+# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
+# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
+# git_name: repository name (%repo%)
+# git_commit: git reference: revision, SHA1, branch... (%commit%)
+# src_prefix: prefix prepended to %source%
+# dst_prefix: prefix prepended to destination name
+# documents: array of documents to fetch
+#
+# DOCUMENT ENTRY:
+# source: subpath within repository (%source%)
+# destination: local destination filename
+# label|title: name within TOC
+# edit|editURI: specific edition URI
+#
+# EXAMPLE:
+# ------------------------------------
+# url: "GERRIT_FETCH"
+# git_commit: "master"
+# repositories:
+# -
+# git_name: src/foo
+# src_prefix: docs
+# dst_prefix: foodocs
+# documents:
+# - source: intro.md
+# label: Introduction
+# - source: topic/README.md
+# destination: topic.md
+# label: My Topic
+# ------------------------------------
+##############################################################################################################
+
+#git_commit: # default defined in _tocs/xxxx/latest.yml
+#dst_prefix: # destination_path = destination_prefix + (document.destination || document.source)
+
+url_fetch: GERRIT_FETCH
+git_commit: AGL_GERRIT_BRANCH
+
+repositories:
+-
+ url_fetch: https://wiki.automotivelinux.org/_media/%source%
+ dst_prefix: AGL_Specifications
+ documents:
+ - source: agl_spec_v1.0_final.pdf
+
+-
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ git_commit: AGL_GITHUB_BRANCH
+ src_prefix: docs/security-blueprint
+ dst_prefix: security
+ documents:
+ - source: README.md
+ label: Introduction
+ - source: WhiteBoxArchi.png
+ label: AGL architecture
+ - source: annexes/0_Abstract.md
+ label: Annexes
+ - source: annexes/ConfigNotes.md
+ label: Config notes
+ - source: annexes/todoNotes.md
+ label: Todo notes
+ - source: part-1/0_Abstract.md
+ label: Introduction
+ - source: part-2/0_Abstract.md
+ label: Introduction
+ - source: part-2/1-Image.md
+ label: Image
+ - source: part-2/2-Communication-modes.md
+ label: Communication modes
+ - source: part-2/3-Consoles.md
+ label: Consoles
+ - source: part-3/0_Abstract.md
+ label: Introduction
+ - source: part-4/0_Abstract.md
+ label: Introduction
+ - source: part-4/1-General.md
+ label: General
+ - source: part-4/2-Memory.md
+ label: Memory
+ - source: part-4/3-Consoles.md
+ label: Consoles
+ - source: part-4/4-Debug.md
+ label: Debug
+ - source: part-4/5-FileSystems.md
+ label: File Systems
+ - source: part-5/0_Abstract.md
+ label: Introduction
+ - source: part-5/1-MAC.md
+ label: Mandatory Access Control
+ - source: part-5/2-SystemD.md
+ label: SystemD
+ - source: part-5/3-SystemBus.md
+ label: SystemBus
+ - source: part-5/4-Services.md
+ label: System services and daemons
+ - source: part-5/5-AppFw.md
+ label: Application Framework
+ - source: part-5/App-flow.png
+ label: Application Framework Flow
+ - source: part-5/6-Utilities.md
+ label: Utilities
+ - source: part-5/7-Users.md
+ label: Users
+ - source: part-6/0_Abstract.md
+ label: Introduction
+ - source: part-6/App_signing_flow.png
+ label: App Signing Flow
+ - source: part-6/1-Installation.md
+ label: Installation
+ - source: part-6/2-PrivilegeManagement.md
+ label: Privilege management
+ - source: part-6/3-Signature.md
+ label: Signature
+ - source: part-6/4-Services.md
+ label: Services
+ - source: part-7/0_Abstract.md
+ label: Introduction
+ - source: part-7/1-BusAndConnectors.md
+ label: Bus and connectors
+ - source: part-7/2-Wireless.md
+ label: Wireless
+ - source: part-7/3-Cloud.md
+ label: Cloud
+ - source: part-8/0_Abstract.md
+ label: Introduction
+ - source: part-8/1-FOTA.md
+ label: FOTA
+ - source: part-8/2-SOTA.md
+ label: SOTA
+ - source: part-9/0_Abstract.md
+ label: Introduction
diff --git a/content/tocs_guppy/architecture/toc_dev_en.yml b/content/tocs_guppy/architecture/toc_dev_en.yml
new file mode 100644
index 0000000..25c6f36
--- /dev/null
+++ b/content/tocs_guppy/architecture/toc_dev_en.yml
@@ -0,0 +1,106 @@
+#######################################################################
+# WARNING:
+# - TOC should reference .HTML and .md (Index OK but Error 404)
+# - do not forget to run 'docbuild --tocs' after any changes
+#
+#
+############################ SYNTAX ###################################
+# GLOBAL OPTIONS:
+# name: TOC (page) title
+# template: name of template to use for this page - use 'generated_index.html' if unknown
+# children: array of TOC entries
+#
+# TOC Entry:
+# name: TOC entry (level 1)
+# children:
+# -
+# name: optional name for TOC entry (default: use URL FrontMatter info)
+# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js:
+# -
+# name: ...
+# url: ...
+# ...
+#
+# EXAMPLE:
+# -------------------------------
+# name: Developer Guides
+# template: generated_index.html
+# children:
+# -
+# name: Application Framework
+# children:
+# - url: reference/af-main/overview.html
+# - url: reference/af-main/afm-system-daemon.html
+# - url: reference/af-main/afm-user-daemon.html
+# -------------------------------
+#######################################################################
+
+name: Architecture Guides
+template: generated_index.html
+children:
+-
+ name: AGL Specifications
+ children:
+ -
+ name: Automotive Grade Linux Requirements Specifications
+ url: reference/AGL_Specifications/agl_spec_v1.0_final.pdf
+-
+ name: Security Blueprint
+ children:
+ - url: reference/security/README.html
+ - name: Part-1 Hardware
+ children:
+ - url: reference/security/part-1/0_Abstract.html
+ - name: Part-2 Secure Boot
+ children:
+ - url: reference/security/part-2/0_Abstract.html
+ - url: reference/security/part-2/1-Image.html
+ - url: reference/security/part-2/2-Communication-modes.html
+ - url: reference/security/part-2/3-Consoles.html
+ - name: Part-3 Hypervisor
+ children:
+ - url: reference/security/part-3/0_Abstract.html
+ - name: Part-4 Kernel
+ children:
+ - url: reference/security/part-4/0_Abstract.html
+ - url: reference/security/part-4/1-General.html
+ - url: reference/security/part-4/2-Memory.html
+ - url: reference/security/part-4/3-Consoles.html
+ - url: reference/security/part-4/4-Debug.html
+ - url: reference/security/part-4/5-FileSystems.html
+ - name: Part-5 Platform
+ children:
+ - url: reference/security/part-5/0_Abstract.html
+ - url: reference/security/part-5/1-MAC.html
+ - url: reference/security/part-5/2-SystemD.html
+ - url: reference/security/part-5/3-SystemBus.html
+ - url: reference/security/part-5/4-Services.html
+ - url: reference/security/part-5/5-AppFw.html
+ - url: reference/security/part-5/6-Utilities.html
+ - url: reference/security/part-5/7-Users.html
+ - name: Part-6 Application
+ children:
+ - url: reference/security/part-6/0_Abstract.html
+ - url: reference/security/part-6/1-Installation.html
+ - url: reference/security/part-6/2-PrivilegeManagement.html
+ - url: reference/security/part-6/3-Signature.html
+ - url: reference/security/part-6/4-Services.html
+ - name: Part-7 Connectivity
+ children:
+ - url: reference/security/part-7/0_Abstract.html
+ - url: reference/security/part-7/1-BusAndConnectors.html
+ - url: reference/security/part-7/2-Wireless.html
+ - url: reference/security/part-7/3-Cloud.html
+ - name: Part-8 Update
+ children:
+ - url: reference/security/part-8/0_Abstract.html
+ - url: reference/security/part-8/1-FOTA.html
+ - url: reference/security/part-8/2-SOTA.html
+ - name: Part-9 Secure development
+ children:
+ - url: reference/security/part-9/0_Abstract.html
+ - name: Annexes
+ children:
+ - url: reference/security/annexes/0_Abstract.html
+ - url: reference/security/annexes/ConfigNotes.html
+ - url: reference/security/annexes/todoNotes.html