diff options
Diffstat (limited to 'content/tocs')
| -rw-r--r-- | content/tocs/apis_services/fetched_files.yml | 187 | ||||
| -rw-r--r-- | content/tocs/apis_services/toc_dev_en.yml | 84 | ||||
| -rw-r--r-- | content/tocs/architecture/fetched_files.yml | 72 | ||||
| -rw-r--r-- | content/tocs/architecture/toc_dev_en.yml | 57 | ||||
| -rw-r--r-- | content/tocs/devguides/fetched_files.yml | 127 | ||||
| -rw-r--r-- | content/tocs/devguides/toc_dev_en.yml | 105 | ||||
| -rw-r--r-- | content/tocs/getting_started/fetched_files.yml | 95 | ||||
| -rw-r--r-- | content/tocs/getting_started/toc_dev_en.yml | 66 | ||||
| -rw-r--r-- | content/tocs/hardware/fetched_files.yml | 58 | ||||
| -rw-r--r-- | content/tocs/hardware/toc_dev_en.yml | 46 |
10 files changed, 897 insertions, 0 deletions
diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml new file mode 100644 index 0000000..24d3194 --- /dev/null +++ b/content/tocs/apis_services/fetched_files.yml @@ -0,0 +1,187 @@ +############################################################################################################## +# 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 +# ------------------------------------ +############################################################################################################## + +url_fetch : "GERRIT_FETCH" +git_commit : "AGL_GERRIT_BRANCH" + +repositories: +- + git_name : src/app-framework-main + git_commit: master + src_prefix : docs + dst_prefix: af-main + documents: + - source: 0-introduction.md + label: Introduction + - source: 1-afm-daemons.md + label: The afm daemons + - source: 2-widgets.md + label: Widgets + - source: 2.1-widgets.md + label: Overview of widgets + - source: 2.2-config.xml.md + label: Widget configuration file + - source: 3-permissions.md + label: Permissions + - source: 4-quick-tutorial.md + label: Quick Tutorial + - source: pictures/afm-daemons.svg + - source: pictures/AppFW-APP_install_sequences.svg + - source: pictures/make-units.svg + - source: pictures/Security_model_history.svg + - source: pictures/triskel_iot_bzh.svg + +- + git_name : src/app-framework-binder + git_commit: master + src_prefix : docs + dst_prefix: af-binder + documents: + - source: afb-overview.md + label: Binder Overview + - source: afb-binding-writing.md + label: How to write a binding ? + - source: afb-binding-references.md + label: Binding references + - source: afb-migration-v1-to-v2.md + label: Migration from v1 to v2 + - source: afb-events-guide.md + label: Binder events guide + - source: afb-application-writing.md + label: Binder Application writing guide + - source: afb-daemon-vocabulary.md + label: Binder daemon vocabulary + - source: afb-desktop-package.md + label: Installing the binder on a desktop + - source: afb-daemon-options.md + label: Options of afb-daemon + - source: pictures/AFB_for_services.svg + - source: pictures/basis.svg + - source: pictures/interconnection.svg + - source: pictures/signaling-basis.svg + - source: pictures/tic-tac-toe.svg + - source: pictures/triskel_iot_bzh.svg + +- + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: "%project_source%/docs-agl" + git_commit: "AGL_GITHUB_BRANCH" + src_prefix: docs/app-framework + dst_prefix: af-binder + documents: + - source: index.md + destination: resources.md + label: Resources +- + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: "%project_source%/docs-agl" + git_commit: "AGL_GITHUB_BRANCH" + src_prefix: docs/signaling + dst_prefix: signaling + documents: + - 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 + - source: images/agent-arch.svg + - source: images/agent-sample.svg + - source: images/cloud-arch.svg + - source: images/can-generator.svg + - 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 + documents: + - source: signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf + - source: signaling/AGL-Message-Signaling-Developer-Guidelines.pdf +- + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: "%project_source%/docs-agl" + git_commit: "AGL_GITHUB_BRANCH" + src_prefix: docs/audio + dst_prefix: audio + documents: + - source: index.md + destination: resources.md + label: Resources +- + url_fetch : GERRIT_FETCH + git_commit : master + git_name : apps/homescreen + src_prefix : homescreen/docs + dst_prefix : homescreen + documents: + - source: homescreen_api.md + label: HomeScreen API + - source: pictures/api_getAllSurfacesOfProcess.png + destination: pictures/api_getAllSurfacesOfProcess.png + - source: pictures/api_getSurfaceStatus_1.png + destination: pictures/api_getSurfaceStatus_1.png + - source: pictures/api_getSurfaceStatus_2.png + destination: pictures/api_getSurfaceStatus_2.png + - source: pictures/api_getSurfaceStatus_3.png + destination: pictures/api_getSurfaceStatus_3.png + - source: pictures/api_hardKeyPressed.png + destination: pictures/api_hardKeyPressed.png + - source: pictures/api_renderSurfaceToArea.png + destination: pictures/api_renderSurfaceToArea.png + - source: pictures/api_renderSurfaceToAreaAllowed.png + destination: pictures/api_renderSurfaceToAreaAllowed.png + - source: pictures/api_requestSurfaceIdToFullScreen.png + 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 new file mode 100644 index 0000000..083a9a7 --- /dev/null +++ b/content/tocs/apis_services/toc_dev_en.yml @@ -0,0 +1,84 @@ +####################################################################### +# 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: Developer Guides +template: generated_index.html +children: +- + name: Application Framework + children: + - url: reference/af-main/0-introduction.html + - url: reference/af-main/1-afm-daemons.html + - url: reference/af-main/2-widgets.html + - url: reference/af-main/2.1-widgets.html + - url: reference/af-main/2.2-config.xml.html + - url: reference/af-main/3-permissions.html + - url: reference/af-main/4-quick-tutorial.html +- + name: Application Framework Binder + children: + - url: reference/af-binder/afb-overview.html + - url: reference/af-binder/afb-binding-writing.html + - url: reference/af-binder/afb-binding-references.html + - url: reference/af-binder/afb-migration-v1-to-v2.html + - url: reference/af-binder/afb-events-guide.html + - url: reference/af-binder/afb-application-writing.html + - url: reference/af-binder/afb-daemon-vocabulary.html + - url: reference/af-binder/afb-desktop-package.html + - url: reference/af-binder/afb-daemon-options.html + +- + 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: Developer Guidelines + url: reference/iotbzh2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf + - name: CAN Signaling Benchmark + url: reference/iotbzh2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf + - url: reference/signaling/resources.html +- + name: Audio Framework + children: + - url: reference/audio/resources.html +- + name: HomeScreen + children: + - url: reference/homescreen/homescreen_api.html + + diff --git a/content/tocs/architecture/fetched_files.yml b/content/tocs/architecture/fetched_files.yml new file mode 100644 index 0000000..8ca29b3 --- /dev/null +++ b/content/tocs/architecture/fetched_files.yml @@ -0,0 +1,72 @@ +############################################################################################################## +# 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 +# ------------------------------------ +############################################################################################################## + +url_fetch : "AGL_GITHUB_FETCH" +url_edit : "AGL_GITHUB_EDIT" +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: +- + url_fetch: https://www.automotivelinux.org/sites/cpstandard/files/pages/files/%source% + dst_prefix: AGL_Specifications + documents: + - source: agl_spec_v1_280515.pdf +- + git_name : "%project_source%/docs-agl" + src_prefix : docs/sec-blueprint + dst_prefix: security + 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 + label: Adversaries + - source: 05-security-concepts.md + label: Security Concepts + - source: 06-plateform-security.md + label: Platform Security + - source: 07-application-security.md + label: Application Security + - source: 08-Hardening.md + label: Harden Configurations diff --git a/content/tocs/architecture/toc_dev_en.yml b/content/tocs/architecture/toc_dev_en.yml new file mode 100644 index 0000000..6d8e2d9 --- /dev/null +++ b/content/tocs/architecture/toc_dev_en.yml @@ -0,0 +1,57 @@ +####################################################################### +# 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_280515.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 diff --git a/content/tocs/devguides/fetched_files.yml b/content/tocs/devguides/fetched_files.yml new file mode 100644 index 0000000..733b8f1 --- /dev/null +++ b/content/tocs/devguides/fetched_files.yml @@ -0,0 +1,127 @@ +############################################################################################################## +# 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 +# ------------------------------------ +############################################################################################################## + +url_fetch : "GERRIT_FETCH" +git_commit: "AGL_GERRIT_BRANCH" +repositories: +- + git_name: AGL/meta-agl + documents: + - source: README-AGL.md + destination: AGL.md + label: AGL Overview + - source: README.md + destination: meta-agl.md + label: meta-agl +- + git_name: AGL/meta-agl-demo + documents: + - source: README.md + destination: meta-agl-demo.md + label: meta-agl-demo +- + git_name: AGL/meta-agl-devel + documents: + - source: README.md + destination: meta-agl-devel.md + label: meta-agl-devel +- + git_name: AGL/meta-agl-extra + documents: + - source: meta-sota/README.md + destination: meta-sota.md + label: meta-sota +- + url_fetch: http://iot.bzh/download/public/2016/%source% + dst_prefix: iotbzh2016 + documents: + - source: sdk/AGL-Kickstart-on-Renesas-Porter-board.pdf + - source: bsp/AGL_Phase2-Devkit-HowTo_bake_a_service.pdf + - source: appfw/03-AGL-AppFW-Privileges-Management.pdf +- + url_fetch: "GITHUB_FETCH" + git_name: iotbzh/agl-documentation + git_commit: "master" + documents: + - source: sdk-devkit/docs/part-1/1_0_Abstract.md + - source: sdk-devkit/docs/part-1/1_1-Deploy_image.md + - source: sdk-devkit/docs/part-1/1_2-Setting-up-your_os.md + - source: sdk-devkit/docs/part-1/1_3-Install-agl-for-porter.md + - source: sdk-devkit/docs/part-1/1_4-Inside-the-container.md + - source: sdk-devkit/docs/part-1/1_5-Build-image-Porter.md + - source: sdk-devkit/docs/part-1/1_6-Porter-image-deployment.md + - source: sdk-devkit/docs/part-1/1_7-SDK-compilation-installation.md + - source: sdk-devkit/docs/part-1/pictures/docker_install_macos_1.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_macos_2.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_macos_3.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_macos_4.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_macos_5.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_macos_6.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_1.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_2.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_3.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_4.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_5.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_6.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_7.png + - source: sdk-devkit/docs/part-1/pictures/renesas_download.jpg + - source: sdk-devkit/docs/part-1/pictures/windows_putty_1.png + - source: sdk-devkit/docs/part-1/pictures/windows_putty_2.png + - source: sdk-devkit/docs/part-1/pictures/windows_win32diskimager_1.png + - source: sdk-devkit/docs/part-1/pictures/windows_win32diskimager_2.png + - source: sdk-devkit/docs/part-1/pictures/windows_win32diskimager_3.png + - source: sdk-devkit/docs/part-1/pictures/windows_win32diskimager_4.png + - 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_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 + + diff --git a/content/tocs/devguides/toc_dev_en.yml b/content/tocs/devguides/toc_dev_en.yml new file mode 100644 index 0000000..e2bc729 --- /dev/null +++ b/content/tocs/devguides/toc_dev_en.yml @@ -0,0 +1,105 @@ +####################################################################### +# 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: Developer Guides +template: generated_index.html +children: +- + name: Yocto layers + children: + - url: reference/AGL.html + - url: reference/meta-agl.html + - url: reference/meta-agl-demo.html + - url: reference/meta-agl-devel.html + - url: referece/meta-sota.html +- + 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 + url: reference/sdk-devkit/docs/part-1/1_4-Inside-the-container.html + - + 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 + 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: 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: Guides + children: + - + name: Kickstart on Renesas Porter board + url: reference/iotbzh2016/sdk/AGL-Kickstart-on-Renesas-Porter-board.pdf + - + name: Devkit - Howto bake a service + url: reference/iotbzh2016/bsp/AGL_Phase2-Devkit-HowTo_bake_a_service.pdf + - + name: AppFW - Privileges Management + url: reference/iotbzh2016/appfw/03-AGL-AppFW-Privileges-Management.pdf diff --git a/content/tocs/getting_started/fetched_files.yml b/content/tocs/getting_started/fetched_files.yml new file mode 100644 index 0000000..8dd0181 --- /dev/null +++ b/content/tocs/getting_started/fetched_files.yml @@ -0,0 +1,95 @@ +############################################################################################################## +# 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 +# ------------------------------------ +############################################################################################################## + +url_fetch : "AGL_GITHUB_FETCH" +url_edit : "AGL_GITHUB_EDIT" +git_commit : "AGL_GITHUB_BRANCH" +#dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) + +repositories: +- + git_name : "%project_source%/docs-agl" + src_prefix : docs/getting-started + documents : + - source: source-code.md + label: Download AGL Source Code + - source: customize_bitbake_conf.md + label: Customize the AGL build + - source: machines/intel.md + label: Build for Intel + - source: machines/qemu.md + label: Build for Qemu + - source: machines/porter.md + label: Build for Renesas Porter board + - source: machines/R-Car-Starter-Kit-gen3.md + label: Build for R Car Starter Kit gen3 board + - source: machines/raspberrypi.md + label: Build for Raspberry PI 2/3 + - source: troubleshooting.md + label: Generic issues + - source: footers/intel-footer.md + label: Intel Boards + - source: footers/porter-footer.md + label: Porter board + - source: footers/raspberrypi-footer.md + label: Raspberry PI + - source: images/RaspberryPi2-ModelB-debug-serial-cable.jpg + destination: footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpg + - source: setup-sdk-environment.md + label: SDK Quick Setup +- + url_fetch : GERRIT_FETCH + git_name : apps/homescreen + git_commit : AGL_GERRIT_BRANCH + src_prefix : homescreen/docs + dst_prefix : homescreen + documents: + - source: index.md + label: Overview + - source: pictures/dashboard.png + destination: pictures/dashboard.png + - source: pictures/homescreen_applauncher.png + destination: pictures/homescreen_applauncher.png + - source: pictures/hvac.png + destination: pictures/hvac.png + - source: pictures/phone.png + destination: pictures/phone.png + - source: pictures/settings.png + destination: pictures/settings.png + diff --git a/content/tocs/getting_started/toc_dev_en.yml b/content/tocs/getting_started/toc_dev_en.yml new file mode 100644 index 0000000..2610f27 --- /dev/null +++ b/content/tocs/getting_started/toc_dev_en.yml @@ -0,0 +1,66 @@ +####################################################################### +# 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: Getting started +template: generated_index.html +children: +- + name: Getting Started + children: + - url: reference/source-code.html + - url: reference/customize_bitbake_conf.html + - url: reference/machines/intel.html + - url: reference/machines/qemu.html + - url: reference/machines/porter.html + - url: reference/machines/R-Car-Starter-Kit-gen3.html + - url: reference/machines/raspberrypi.html +- + name: HomeScreen + children: + - url: reference/homescreen/index.html +- + name: Troubleshooting + children: + - url: reference/troubleshooting.html + - url: reference/footers/intel-footer.html + - url: reference/footers/porter-footer.html + - url: reference/footers/raspberrypi-footer.html +- + name: SDK + children: + - url: reference/setup-sdk-environment.html + diff --git a/content/tocs/hardware/fetched_files.yml b/content/tocs/hardware/fetched_files.yml new file mode 100644 index 0000000..62b1c0d --- /dev/null +++ b/content/tocs/hardware/fetched_files.yml @@ -0,0 +1,58 @@ +############################################################################################################## +# 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 +# ------------------------------------ +############################################################################################################## + +url_fetch : "GERRIT_FETCH" +git_commit : "AGL_GERRIT_BRANCH" +#dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) + +repositories: +- + git_name: AGL/meta-renesas + dst_prefix: renesas + documents: + - source: meta-rcar-gen2/README + destination: gen2.md + label: meta-rcar-gen2 layer + - source: meta-rcar-gen2/README.proprietary + destination: proprietary.md + label: Proprietary drivers + - source: meta-rcar-gen2/README-usbgadget.md + destination: usb-gadget.md + label: USB Gadget on Porter board + diff --git a/content/tocs/hardware/toc_dev_en.yml b/content/tocs/hardware/toc_dev_en.yml new file mode 100644 index 0000000..0c6b9a5 --- /dev/null +++ b/content/tocs/hardware/toc_dev_en.yml @@ -0,0 +1,46 @@ +####################################################################### +# 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: Hardware Support +template: generated_index.html +children: +- + name: Renesas Boards + children: + - url: reference/renesas/gen2.html + - url: reference/renesas/proprietary.html + - url: reference/renesas/usb-gadget.html |