diff options
Diffstat (limited to 'content/tocs/devguides')
| -rw-r--r-- | content/tocs/devguides/section_flounder.yml | 4 | ||||
| -rw-r--r-- | content/tocs/devguides/section_guppy.yml | 9 | ||||
| -rw-r--r-- | content/tocs/devguides/section_halibut.yml | 66 | ||||
| -rw-r--r-- | content/tocs/devguides/section_master.yml | 9 | ||||
| -rw-r--r-- | content/tocs/devguides/toc_dev_en.yml | 270 |
5 files changed, 78 insertions, 280 deletions
diff --git a/content/tocs/devguides/section_flounder.yml b/content/tocs/devguides/section_flounder.yml index 1eac9ca..6230e19 100644 --- a/content/tocs/devguides/section_flounder.yml +++ b/content/tocs/devguides/section_flounder.yml @@ -54,12 +54,12 @@ books: books: - id: how-to-write-test-1 - path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf + path: https://raw.githubusercontent.com/BayLibre/agl-docs-baylibre/master/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf git_commit: master name: How to write tests (overview slides) - id: how-to-write-test-2 - path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/Hands_on_lab_documentation.pdf + path: https://raw.githubusercontent.com/BayLibre/agl-docs-baylibre/master/CIAT/training/Hands_on_lab_documentation.pdf git_commit: master name: How to write tests (detailed) diff --git a/content/tocs/devguides/section_guppy.yml b/content/tocs/devguides/section_guppy.yml index 7408b41..84f12b3 100644 --- a/content/tocs/devguides/section_guppy.yml +++ b/content/tocs/devguides/section_guppy.yml @@ -1,4 +1,5 @@ url_fetch : "GERRIT_FETCH" +git_commit : "guppy" name: Developers Guides template: generated_index.html @@ -39,8 +40,8 @@ books: dst_prefix: iotbzh2016 name: AppFW - Privileges Management - - id: app-controller-submodule-guides - git_name: apps/app-controller-submodule + id: libappcontroller-guides + git_name: src/libappcontroller path: docs/devguides-book.yml dst_prefix: ctrler - @@ -59,10 +60,10 @@ books: - id: how-to-write-test-1 git_commit: master - path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf + path: https://raw.githubusercontent.com/BayLibre/agl-docs-baylibre/master/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf name: How to write tests (overview slides) - id: how-to-write-test-2 git_commit: master - path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/Hands_on_lab_documentation.pdf + path: https://raw.githubusercontent.com/BayLibre/agl-docs-baylibre/master/CIAT/training/Hands_on_lab_documentation.pdf name: How to write tests (detailed) diff --git a/content/tocs/devguides/section_halibut.yml b/content/tocs/devguides/section_halibut.yml new file mode 100644 index 0000000..ce36791 --- /dev/null +++ b/content/tocs/devguides/section_halibut.yml @@ -0,0 +1,66 @@ +url_fetch : "GERRIT_FETCH" +git_commit : "halibut" + +name: Developers Guides +template: generated_index.html +books: +- + id: meta-agl-developer-guides + git_name: AGL/meta-agl + path: docs/devguides-book.yml + brotherBooks: + - + id: meta-agl-demo-guides + git_name: AGL/meta-agl-demo + path: docs/devguides-book.yml + - + id: meta-agl-devel-guides + git_name: AGL/meta-agl-devel + path: docs/devguides-book.yml +- + id: host-configuration-developer-guides + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: iotbzh/agl-documentation + path: host-configuration/docs/devguides-book.yml +- + id: cmake-apps-module-guides + git_name: src/cmake-apps-module + path: docs/devguides-book.yml + dst_prefix: "cmakeafbtemplates" +- + id: xds-docs-guides + git_name: src/xds/xds-docs + path: docs/devguides-book.yml + dst_prefix: "xds" +- + id: appfw-privileges-management + path: https://iot.bzh/download/public/2016/appfw/03-AGL-AppFW-Privileges-Management.pdf + dst_prefix: iotbzh2016 + name: AppFW - Privileges Management +- + id: libappcontroller-guides + git_name: src/libappcontroller + path: docs/devguides-book.yml + dst_prefix: ctrler +- + id: afb-helpers-function-references + git_name: src/libafb-helpers + path: docs/afb-helpers-book.yml + dst_prefix: afb-helpers +- + id: continuous-integration-ciat + name: Continuous Integration - Automated Testing (CIAT) + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + path: docs/continuous-integration-book.yml + books: + - + id: how-to-write-test-1 + path: https://raw.githubusercontent.com/BayLibre/agl-docs-baylibre/master/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf + name: How to write tests (overview slides) + - + id: how-to-write-test-2 + path: https://raw.githubusercontent.com/BayLibre/agl-docs-baylibre/master/CIAT/training/Hands_on_lab_documentation.pdf + name: How to write tests (detailed) diff --git a/content/tocs/devguides/section_master.yml b/content/tocs/devguides/section_master.yml index cfe3089..9b1c489 100644 --- a/content/tocs/devguides/section_master.yml +++ b/content/tocs/devguides/section_master.yml @@ -1,4 +1,5 @@ url_fetch : "GERRIT_FETCH" +git_commit : "master" name: Developers Guides template: generated_index.html @@ -38,8 +39,8 @@ books: dst_prefix: iotbzh2016 name: AppFW - Privileges Management - - id: app-controller-submodule-guides - git_name: apps/app-controller-submodule + id: libappcontroller-guides + git_name: src/libappcontroller path: docs/devguides-book.yml dst_prefix: ctrler - @@ -57,9 +58,9 @@ books: books: - id: how-to-write-test-1 - path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf + path: https://raw.githubusercontent.com/BayLibre/agl-docs-baylibre/master/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf name: How to write tests (overview slides) - id: how-to-write-test-2 - path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/Hands_on_lab_documentation.pdf + path: https://raw.githubusercontent.com/BayLibre/agl-docs-baylibre/master/CIAT/training/Hands_on_lab_documentation.pdf name: How to write tests (detailed) diff --git a/content/tocs/devguides/toc_dev_en.yml b/content/tocs/devguides/toc_dev_en.yml deleted file mode 100644 index 551ae12..0000000 --- a/content/tocs/devguides/toc_dev_en.yml +++ /dev/null @@ -1,270 +0,0 @@ -####################################################################### -# 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: AGL layers - children: - - url: reference/AGL.html - - url: reference/meta-agl.html - - url: reference/meta-agl-demo.html - - url: reference/meta-agl-devel.html -- - name: Host Configuration - children: - - - name: Abstract - url: reference/host-configuration/docs/0_Abstract.html - - - name: Prerequisites - url: reference/host-configuration/docs/1_Prerequisites.html - - - name: AGL Application Framework - url: reference/host-configuration/docs/2_AGL_Application_Framework.html - - - name: Binding Build Example - url: reference/host-configuration/docs/3_Binding_Build_Example.html - - - name: AGL XDS - url: reference/host-configuration/docs/4_AGL_XDS.html - - - name: CanDevStudio - url: reference/host-configuration/docs/5_Candevstudio.html -- - name: "Usage of CMake Afb Template module" - children: - - - name: "Abstract" - url: "reference/cmakeafbtemplates/0_Abstract.html" - - - name: "Quickstart" - url: "reference/cmakeafbtemplates/1_Quickstart.html" - - - name: "Project architecture" - url: "reference/cmakeafbtemplates/2_project_architecture.html" - - - name: "Advanced usage" - url: "reference/cmakeafbtemplates/3_advanced_usage.html" - - - name: "Advanced customization" - url: "reference/cmakeafbtemplates/4_advanced_customization.html" - - - name: "The autobuild script" - url: "reference/cmakeafbtemplates/5_autobuild.html" -- - name: "X(cross) Development System: User's Guide" - children: - - - name: Getting Started - url: reference/xds/part-1/0_Abstract.html - - - name: Installing xds-server - children: - - - name: Installation - url: reference/xds/part-1/1_install-xds-server.html - - - name: Based on Docker container - url: reference/xds/part-1/1-1_install-xds-server-docker.html - - - name: Based on Virtual Machine appliance - url: reference/xds/part-1/1-2_install-xds-server-vm.html - - - name: Native installation - url: reference/xds/part-1/1-3_install-xds-server-native.html - - - name: Installing xds client tools - url: reference/xds/part-1/2_install-client.html - - - name: Installing AGL SDKs - url: reference/xds/part-1/3_install-sdks.html - - - name: Create your first AGL application - children: - - - name: Prerequisites - url: reference/xds/part-1/4_build-first-app.html - - - name: Setup - url: reference/xds/part-1/4-1_build-first-app-setup.html - - - name: Build using command line tool - url: reference/xds/part-1/4-2_build-first-app-cmd.html - - - name: Build using XDS Dashboard - url: reference/xds/part-1/4-3_build-first-app-dashboard.html - - - name: Build using a source code editor / IDE - url: reference/xds/part-1/4-4_build-first-app-ide.html - - - name: Debug your first AGL application - children: - - - name: Prerequisites - url: reference/xds/part-1/5_debug-first-app.html - - - name: Configuration - url: reference/xds/part-1/5-1_debug-first-app-config.html - - - name: xds-gdb from command line - url: reference/xds/part-1/5-2_debug-first-app-cmd.html - - - name: xds-gdb within an IDE - url: reference/xds/part-1/5-3_debug-first-app-ide.html - -- - name: "X(cross) Development System: Internals" - children: - - - name: Abstract - url: reference/xds/part-2/0_Abstract.html - - - name: Prerequisites - url: reference/xds/part-2/1_Prerequisites.html - - - name: XDS-server - children: - - - name: Abstract - url: reference/xds/part-2/1_xds-server/0_abstract.html - - - name: Build from scratch - url: reference/xds/part-2/1_xds-server/1_build.html - - - name: Configuration - url: reference/xds/part-2/1_xds-server/2_config.html - - - name: How to run - url: reference/xds/part-2/1_xds-server/3_how-to-run.html - - - name: Debugging - url: reference/xds/part-2/1_xds-server/4_debug.html - - - name: Test - url: reference/xds/part-2/1_xds-server/5_test.html - - - name: XDS-agent - children: - - - name: Abstract - url: reference/xds/part-2/2_xds-agent/0_abstract.html - - - name: Build from scratch - url: reference/xds/part-2/2_xds-agent/1_build.html - - - name: Configuration - url: reference/xds/part-2/2_xds-agent/2_config.html - - - name: Start - url: reference/xds/part-2/2_xds-agent/3_start.html - - - name: Debugging - url: reference/xds/part-2/2_xds-agent/4_debug.html - - - name: XDS-cli - children: - - - name: Abstract - url: reference/xds/part-2/3_xds-cli/0_abstract.html - - - name: Build from scratch - url: reference/xds/part-2/3_xds-cli/1_build.html - - - name: Configuration - url: reference/xds/part-2/3_xds-cli/2_config.html - - - name: CLI Commands - url: reference/xds/part-2/3_xds-cli/3_commands.html - - - name: Debugging - url: reference/xds/part-2/3_xds-cli/4_debug.html - - - name: XDS-gdb - children: - - - name: Abstract - url: reference/xds/part-2/4_xds-gdb/0_abstract.html - - - name: Build from scratch - url: reference/xds/part-2/4_xds-gdb/1_build.html - - - name: Configuration - url: reference/xds/part-2/4_xds-gdb/2_config.html - - - name: Debugging - url: reference/xds/part-2/4_xds-gdb/3_debug.html -- - name: Guides - children: - - - name: AppFW - Privileges Management - url: reference/iotbzh2016/appfw/03-AGL-AppFW-Privileges-Management.pdf - -- - name: Controller Guide - children: - - url: reference/ctrler/controller.html - - url: reference/ctrler/controllerConfig.html - - url: reference/ctrler/Usage.html - - url: reference/ctrler/configSample.html - -- - name: AFB Helper functions reference - children: - - url: reference/afb-helpers/usage.html - - url: reference/afb-helpers/afb-timer.html - - url: reference/afb-helpers/curl-wrap.html - - url: reference/afb-helpers/escape.html - - url: reference/afb-helpers/filescan-utils.html - - url: reference/afb-helpers/qafbwebsocketclient.html - - url: reference/afb-helpers/json.html - - url: reference/afb-helpers/wrap-json.html - -- - name: "Continuous Integration - Automated Testing (CIAT)" - children: - - - name: Training - children: - - - name: "How to write tests (overview slides)" - url: reference/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf - - - name: "How to write tests (detailed)" - url: reference/CIAT/training/Hands_on_lab_documentation.pdf |