diff options
Diffstat (limited to 'content')
| -rw-r--r-- | content/tocs/apis_services/fetched_files.yml | 104 | ||||
| -rw-r--r-- | content/tocs/apis_services/toc_dev_en.yml | 25 | ||||
| -rw-r--r-- | content/tocs/architecture/fetched_files.yml | 106 | ||||
| -rw-r--r-- | content/tocs/architecture/toc_dev_en.yml | 83 | ||||
| -rw-r--r-- | content/tocs/devguides/fetched_files.yml | 57 | ||||
| -rw-r--r-- | content/tocs/devguides/toc_dev_en.yml | 92 |
6 files changed, 391 insertions, 76 deletions
diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml index 24d3194..da0758b 100644 --- a/content/tocs/apis_services/fetched_files.yml +++ b/content/tocs/apis_services/fetched_files.yml @@ -23,7 +23,7 @@ # ------------------------------------ # url: "GERRIT_FETCH" # git_commit: "master" -# repositories: +# repositories: # - # git_name: src/foo # src_prefix: docs @@ -40,7 +40,7 @@ url_fetch : "GERRIT_FETCH" git_commit : "AGL_GERRIT_BRANCH" -repositories: +repositories: - git_name : src/app-framework-main git_commit: master @@ -99,6 +99,39 @@ repositories: - source: pictures/triskel_iot_bzh.svg - + git_name : apps/low-level-can-service + git_commit: master + src_prefix : docs + dst_prefix: signaling + documents: + - source: 1-Architecture.md + destination: low-can-architecture.md + label: Architecture presentation + - source: 2-Installation.md + destination: low-can-installation-guide.md + label: Installation Guide + - source: 3-Usage.md + destination: low-can-usage-guide.md + label: Usage Guide + - source: images/CAN_bindings_communication.png + - source: images/CAN_level_mapping.png + - source: images/OpenXC_to_AGL.png + +- + url_fetch: GITHUB_FETCH + git_name : iotbzh/high-level-viwi-service + git_commit: master + src_prefix : docs + dst_prefix: signaling + documents: + - source: 1-Architecture.md + destination: high-viwi-architecture.md + label: Architecture presentation + - source: 2-Install-Usage.md + destination: high-viwi-install-usage-guide.md + label: Installation and Usage Guide + - source: images/high-level-arch.png +- url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT git_name: "%project_source%/docs-agl" @@ -120,12 +153,6 @@ repositories: - source: architecture.md destination: architecture.md label: Signaling Architecture - - source: low-level-can-service-guide.md - destination: low-level-can-service-guide.md - label: Low level CAN service Guide - - source: high-level-viwi-service.md - destination: high-level-viwi-service.md - label: High level ViWi service Guide - source: index.md destination: resources.md label: Resources @@ -136,10 +163,6 @@ repositories: - source: images/distributed-arch.svg - source: images/distributed-arch.png - source: images/signal-service-arch.svg - - source: images/OpenXC_to_AGL.png - - source: images/CAN_level_mapping.png - - source: images/CAN_bindings_communication.png - - source: images/high-level-arch.png - url_fetch: http://iot.bzh/download/public/2016/%source% dst_prefix: iotbzh2016 @@ -158,6 +181,62 @@ repositories: destination: resources.md label: Resources - + url_fetch: "GERRIT_FETCH" + git_name: apps/agl-service-homescreen-2017 + git_commit: "master" + src_prefix: doc/ + dst_prefix: hmi-framework/ + documents: + - source: ApplicationGuide.md + destination: 3_1-HomeScreen-Guide.md + label: Home Screen Developper Guide + - source: parts/initialize.svg + - source: parts/initialize-registercallback.svg + - source: parts/initialize-set-event-handler.svg + - source: parts/on_screen_message.svg + - source: parts/software-stack.png + - source: parts/tap_shortcut.svg +- + url_fetch: "GERRIT_FETCH" + git_name: apps/agl-service-windowmanager-2017 + git_commit: "master" + src_prefix: doc/ + dst_prefix: hmi-framework/ + documents: + - source: ApplicationGuide.md + destination: 3_2-WindowManager-Guide.md + label: Window Manager Developper Guide +- + url_fetch: "GERRIT_FETCH" + git_name: apps/agl-service-soundmanager-2017 + git_commit: "master" + src_prefix: doc/ + dst_prefix: hmi-framework/ + documents: + - source: ApplicationGuide.md + destination: 3_3-SoundManager-Guide.md + label: Sound Manager Developper Guide + - source: Display_Audio_Transition1.md + destination: Display_Audio_Transition1.md + label: Sound Manager Developper Guide 2 + - source: Display_Audio_Transition2.md + destination: Display_Audio_Transition2.md + label: Sound Manager Developper Guide 3 + - source: parts/seq_startup.svg + - source: parts/am-component.png + - source: parts/seq_registration.svg + - source: parts/seq_connectsoundroute.svg + - source: parts/seq_startsoundstreaming.svg + - source: parts/seq_requestsoundmode.svg + - source: parts/seq_setmutestate.svg + - source: parts/seq_changevolume.svg + - source: parts/seq_stopsoundstreaming.svg + - source: parts/seq_disconnectsoundroute.svg + - source: parts/software-stack.png + - source: parts/seq_releasesoundmode.svg + - source: parts/typical-usecase.png + - source: parts/am-component.png +- url_fetch : GERRIT_FETCH git_commit : master git_name : apps/homescreen @@ -184,4 +263,3 @@ repositories: destination: pictures/api_requestSurfaceIdToFullScreen.png - source: pictures/api_surfaceVisibilityChanged.png destination: pictures/api_surfaceVisibilityChanged.png - diff --git a/content/tocs/apis_services/toc_dev_en.yml b/content/tocs/apis_services/toc_dev_en.yml index 083a9a7..3c3e4a9 100644 --- a/content/tocs/apis_services/toc_dev_en.yml +++ b/content/tocs/apis_services/toc_dev_en.yml @@ -65,8 +65,15 @@ children: name: Message Signaling children: - url: reference/signaling/architecture.html - - url: reference/signaling/low-level-can-service-guide.html - - url: reference/signaling/high-level-viwi-service.html + - name: Low level CAN service Guide + children: + - url: reference/signaling/low-can-architecture.html + - url: reference/signaling/low-can-installation-guide.html + - url: reference/signaling/low-can-usage-guide.html + - name: High level ViWi service Guide + children: + - url: reference/signaling/high-viwi-architecture.html + - url: reference/signaling/high-viwi-install-usage-guide.html - name: Developer Guidelines url: reference/iotbzh2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf - name: CAN Signaling Benchmark @@ -77,7 +84,19 @@ children: children: - url: reference/audio/resources.html - - name: HomeScreen + name: HMI Framework + children: + - + name: Home Screen Developper Guide + url: reference/hmi-framework/3_1-HomeScreen-Guide.html + - + name: Window Manager Developper Guide + url: reference/hmi-framework/3_2-WindowManager-Guide.html + - + name: Sound Manager Developper Guide + url: reference/hmi-framework/3_3-SoundManager-Guide.html +- + name: HomeScreen (old) children: - url: reference/homescreen/homescreen_api.html diff --git a/content/tocs/architecture/fetched_files.yml b/content/tocs/architecture/fetched_files.yml index f594fde..080c9cb 100644 --- a/content/tocs/architecture/fetched_files.yml +++ b/content/tocs/architecture/fetched_files.yml @@ -23,7 +23,7 @@ # ------------------------------------ # url: "GERRIT_FETCH" # git_commit: "master" -# repositories: +# repositories: # - # git_name: src/foo # src_prefix: docs @@ -43,7 +43,7 @@ git_commit : "AGL_GITHUB_BRANCH" #git_commit : # default defined in _tocs/xxxx/latest.yml #dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) -repositories: +repositories: - url_fetch: https://wiki.automotivelinux.org/_media/%source% dst_prefix: AGL_Specifications @@ -56,17 +56,99 @@ repositories: documents: - source: 01-overview.md label: Overview - - source: 02-threat-analysis.md - label: Threat Analysis - - source: 03-attack-surfaces.md - label: Attack Surfaces - - source: 04-adversaries.md + - source: 02-adversaries.md label: Adversaries - - source: 05-security-concepts.md + - source: 03-threat-analysis.md + label: Threat Analysis + - source: 04-security-concepts.md label: Security Concepts - - source: 06-plateform-security.md + - source: 05-platform-security.md label: Platform Security - - source: 07-application-security.md + - source: 06-application-security.md label: Application Security - - source: 08-Hardening.md - label: Harden Configurations + - source: 07-system-hardening.md + label: System Hardening + +- + git_name : "%project_source%/docs-agl" + 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/todo.md + label: todo + - 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: App Framework + - 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/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/architecture/toc_dev_en.yml b/content/tocs/architecture/toc_dev_en.yml index 15afae7..0dae730 100644 --- a/content/tocs/architecture/toc_dev_en.yml +++ b/content/tocs/architecture/toc_dev_en.yml @@ -1,9 +1,9 @@ ####################################################################### -# WARNING: +# WARNING: # - TOC should reference .HTML and .md (Index OK but Error 404) -# - do not forget to run 'docbuild --tocs' after any changes +# - do not forget to run 'docbuild --tocs' after any changes +# # -# ############################ SYNTAX ################################### # GLOBAL OPTIONS: # name: TOC (page) title @@ -13,7 +13,7 @@ # 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: # - @@ -41,17 +41,76 @@ 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/01-overview.html -# - url: reference/security/02-threat-analysis.html -# - url: reference/security/03-attack-surfaces.html - - url: reference/security/04-adversaries.html - - url: reference/security/05-security-concepts.html - - url: reference/security/06-plateform-security.html - - url: reference/security/07-application-security.html - - url: reference/security/08-Hardening.html + - url: reference/security/02-adversaries.html + - url: reference/security/03-threat-analysis.htm + - url: reference/security/04-security-concepts.html + - url: reference/security/05-platform-security.html + - url: reference/security/06-application-security.html + - url: reference/security/07-system-hardening.html +- + name: Upgraded Security Blueprint 2017 + 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 diff --git a/content/tocs/devguides/fetched_files.yml b/content/tocs/devguides/fetched_files.yml index eda5f20..b5da97a 100644 --- a/content/tocs/devguides/fetched_files.yml +++ b/content/tocs/devguides/fetched_files.yml @@ -23,7 +23,7 @@ # ------------------------------------ # url: "GERRIT_FETCH" # git_commit: "master" -# repositories: +# repositories: # - # git_name: src/foo # src_prefix: docs @@ -39,7 +39,7 @@ url_fetch : "GERRIT_FETCH" git_commit: "AGL_GERRIT_BRANCH" -repositories: +repositories: - git_name: AGL/meta-agl documents: @@ -102,18 +102,53 @@ repositories: - source: sdk-devkit/docs/part-1/pictures/windows_win32diskimager_5.png - source: sdk-devkit/docs/part-2/2_0_Abstract.md - source: sdk-devkit/docs/part-2/2_1-Init-sdk-env.md - - source: sdk-devkit/docs/part-2/2_2-Trying-out-templates.md + - source: sdk-devkit/docs/part-2/2_2-Trying-out-template.md - source: sdk-devkit/docs/part-2/2_3-Dev-with-container.md - - source: sdk-devkit/docs/part-2/2_4-Creating-hybrid-app.md - - source: sdk-devkit/docs/part-2/pictures/cpu_hybrid_qml.png - - source: sdk-devkit/docs/part-2/pictures/html5_app.png - - source: sdk-devkit/docs/part-2/pictures/hybrid_html5_app_on_target.png - - source: sdk-devkit/docs/part-2/pictures/hybrid_html5_app.png - - source: sdk-devkit/docs/part-2/pictures/hybrid_qml_app.png - source: sdk-devkit/docs/part-2/pictures/mac_x11_logo.png - source: sdk-devkit/docs/part-2/pictures/putty_config.png - source: sdk-devkit/docs/part-2/pictures/qml_app.png - source: sdk-devkit/docs/part-2/pictures/web-runtime_app.png - source: sdk-devkit/docs/part-2/pictures/xming_server.png - - +- + url_fetch: "GERRIT_FETCH" + git_name: apps/app-templates + git_commit: "master" + dst_prefix: sdk-devkit/docs/part-2 + documents: + - source: README.md + destination: 2_4-Use-app-templates.md +- + url_fetch: "GITHUB_FETCH" + git_name: iotbzh/xds-docs + git_commit: "master" + src_prefix: "docs" + dst_prefix: "xds" + documents: + - source: part-1/0_Abstract.md + - source: part-1/1_install-client.md + - source: part-1/2_install-xds-server.md + - source: part-1/3_install-sdks.md + - source: part-1/4_build-first-app.md + - source: part-1/5_debug-first-app.md + - source: part-1/pictures/nb_new-project-1.png + - source: part-1/pictures/nb_new-project-2.png + - source: part-1/pictures/nb_new-project-3.png + - source: part-1/pictures/nb_new-project-4.png + - source: part-1/pictures/nb_new-project-5.png + - source: part-1/pictures/nb_newtool.png + - source: part-1/pictures/nb_project_debug-1.png + - source: part-1/pictures/nb_xds_options.png + - source: part-1/pictures/xds-block-chain.png + - source: part-1/pictures/xds-block-diagram.png + - source: part-1/pictures/xds-conf.png + - source: part-1/pictures/xds-dashboard-icon-1.png + - source: part-1/pictures/xds-dashboard-icon-2.png + - source: part-1/pictures/xds-dashboard-icon-3.png + - source: part-1/pictures/xds-dashboard-prj-1.png + - source: part-1/pictures/xds-dashboard-prj-2.png + - source: part-2/0_Abstract.md + - source: part-2/1_xds-server.md + - source: part-2/2_xds-agent.md + - source: part-2/3_xds-cli.md + - source: part-2/4_xds-gdb.md + - source: part-2/5_xds-exec.md diff --git a/content/tocs/devguides/toc_dev_en.yml b/content/tocs/devguides/toc_dev_en.yml index 5de613a..00dcc39 100644 --- a/content/tocs/devguides/toc_dev_en.yml +++ b/content/tocs/devguides/toc_dev_en.yml @@ -1,9 +1,9 @@ ####################################################################### -# WARNING: +# WARNING: # - TOC should reference .HTML and .md (Index OK but Error 404) -# - do not forget to run 'docbuild --tocs' after any changes +# - do not forget to run 'docbuild --tocs' after any changes +# # -# ############################ SYNTAX ################################### # GLOBAL OPTIONS: # name: TOC (page) title @@ -13,7 +13,7 @@ # 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: # - @@ -48,50 +48,92 @@ children: - name: "Development Kit: build AGL image" children: - - + - name: Abstract url: reference/sdk-devkit/docs/part-1/1_0_Abstract.html - - + - name: Deploy image url: reference/sdk-devkit/docs/part-1/1_1-Deploy_image.html - - + - name: Setting up your operating system url: reference/sdk-devkit/docs/part-1/1_2-Setting-up-your_os.html - - + - name: Install Docker image url: reference/sdk-devkit/docs/part-1/1_3-Install-agl-for-porter.html - - - name: Inside the container + - + name: Inside the container url: reference/sdk-devkit/docs/part-1/1_4-Inside-the-container.html - - - name: Build image for Porter + - + name: Build image for Porter url: reference/sdk-devkit/docs/part-1/1_5-Build-image-Porter.html - - + - name: Porter image deployment url: reference/sdk-devkit/docs/part-1/1_6-Porter-image-deployment.html - - - name: SDK compilation and installation + - + name: SDK compilation and installation url: reference/sdk-devkit/docs/part-1/1_7-SDK-compilation-installation.html - name: "Development Kit: build AGL application" children: - - + - name: Abstract url: reference/sdk-devkit/docs/part-2/2_0_Abstract.html - - + - name: Initialize SDK environment url: reference/sdk-devkit/docs/part-2/2_1-Init-sdk-env.html - - - name: Trying out templates - url: reference/sdk-devkit/docs/part-2/2_2-Trying-out-templates.html - - + - + name: Trying out template + url: reference/sdk-devkit/docs/part-2/2_2-Trying-out-template.html + - name: Developing with container url: reference/sdk-devkit/docs/part-2/2_3-Dev-with-container.html - - - name: Creating an hybrid app - url: reference/sdk-devkit/docs/part-2/2_4-Creating-hybrid-app.html + - + name: Use CMake templates to develop an app + url: reference/sdk-devkit/docs/part-2/2_4-Use-app-templates.html +- + name: "X(cross) Development System: User's Guide" + children: + - + name: Getting Started + url: reference/xds/part-1/0_Abstract.html + - + name: Installing xds client tools + url: reference/xds/part-1/1_install-client.html + - + name: Installing xds-server + url: reference/xds/part-1/2_install-xds-server.html + - + name: Installing AGL SDKs + url: reference/xds/part-1/3_install-sdks.html + - + name: Create your first AGL application + url: reference/xds/part-1/4_build-first-app.html + - + name: Debug your first AGL application + url: reference/xds/part-1/5_debug-first-app.html +- + name: "X(cross) Development System: Internals" + children: + - + name: Abstract + url: reference/xds/part-2/0_Abstract.html + - + name: xds-server + url: reference/xds/part-2/1_xds-server.html + - + name: xds-agent + url: reference/xds/part-2/2_xds-agent.html + - + name: xds-cli + url: reference/xds/part-2/3_xds-cli.html + - + name: xds-gdb + url: reference/xds/part-2/4_xds-gdb.html + - + name: xds-exec + url: reference/xds/part-2/5_xds-exec.html - - name: Guides + name: Guides children: - name: AppFW - Privileges Management |