diff options
Diffstat (limited to 'content/tocs/devguides')
-rw-r--r-- | content/tocs/devguides/fetched_files.yml | 195 | ||||
-rw-r--r-- | content/tocs/devguides/section_flounder.yml | 66 | ||||
-rw-r--r-- | content/tocs/devguides/section_guppy.yml | 68 | ||||
-rw-r--r-- | content/tocs/devguides/section_master.yml | 65 | ||||
-rw-r--r-- | content/tocs/devguides/toc_dev_en.yml | 2 |
5 files changed, 200 insertions, 196 deletions
diff --git a/content/tocs/devguides/fetched_files.yml b/content/tocs/devguides/fetched_files.yml deleted file mode 100644 index 1df36b1..0000000 --- a/content/tocs/devguides/fetched_files.yml +++ /dev/null @@ -1,195 +0,0 @@ -############################################################################################################## -# 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 -- - url_fetch: https://iot.bzh/download/public/2016/%source% - dst_prefix: iotbzh2016 - documents: - - source: appfw/03-AGL-AppFW-Privileges-Management.pdf -- - url_fetch: "GITHUB_FETCH" - git_name: iotbzh/agl-documentation - git_commit: "master" - documents: - - source: host-configuration/docs/0_Abstract.md - - source: host-configuration/docs/1_Prerequisites.md - - source: host-configuration/docs/2_AGL_Application_Framework.md - - source: host-configuration/docs/3_Binding_Build_Example.md - - source: host-configuration/docs/4_AGL_XDS.md - - source: host-configuration/docs/5_Candevstudio.md -- - git_name: src/cmake-apps-module - src_prefix: "docs/dev_guide" - dst_prefix: "cmakeafbtemplates" - documents: - - source: 0_Abstract.md - - source: 1_Quickstart.md - - source: 2_project_architecture.md - - source: 3_advanced_usage.md - - source: 4_advanced_customization.md - - source: 5_autobuild.md -- - git_name: src/xds/xds-docs - src_prefix: "docs" - dst_prefix: "xds" - documents: - - source: part-1/0_Abstract.md - - source: part-1/1_install-xds-server.md - - source: part-1/1-1_install-xds-server-docker.md - - source: part-1/1-2_install-xds-server-vm.md - - source: part-1/1-3_install-xds-server-native.md - - source: part-1/2_install-client.md - - source: part-1/3_install-sdks.md - - source: part-1/4-1_build-first-app-setup.md - - source: part-1/4-2_build-first-app-cmd.md - - source: part-1/4-3_build-first-app-dashboard.md - - source: part-1/4-4_build-first-app-ide.md - - source: part-1/4_build-first-app.md - - source: part-1/5-1_debug-first-app-config.md - - source: part-1/5-2_debug-first-app-cmd.md - - source: part-1/5-3_debug-first-app-ide.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-1/pictures/xds-dashboard-sdks-install.png - - source: part-1/pictures/xds-dashboard-sdks-mgt.png - - source: part-2/0_Abstract.md - - source: part-2/1_Prerequisites.md - - source: part-2/1_xds-server/0_abstract.md - - source: part-2/1_xds-server/1_build.md - - source: part-2/1_xds-server/2_config.md - - source: part-2/1_xds-server/3_how-to-run.md - - source: part-2/1_xds-server/4_debug.md - - source: part-2/1_xds-server/5_test.md - - source: part-2/2_xds-agent/0_abstract.md - - source: part-2/2_xds-agent/1_build.md - - source: part-2/2_xds-agent/2_config.md - - source: part-2/2_xds-agent/3_start.md - - source: part-2/2_xds-agent/4_debug.md - - source: part-2/3_xds-cli/0_abstract.md - - source: part-2/3_xds-cli/1_build.md - - source: part-2/3_xds-cli/2_config.md - - source: part-2/3_xds-cli/3_commands.md - - source: part-2/3_xds-cli/4_debug.md - - source: part-2/4_xds-gdb/0_abstract.md - - source: part-2/4_xds-gdb/1_build.md - - source: part-2/4_xds-gdb/2_config.md - - source: part-2/4_xds-gdb/3_debug.md - -- - url_fetch: GITHUB_FETCH - url_edit: GITHUB_EDIT - git_name: baylibre/agl-docs-baylibre - git_commit: master - documents: - - source: CIAT/training/How_to_write_your_own_tests_for_AGL.pdf - - source: CIAT/training/Hands_on_lab_documentation.pdf -- - git_name: src/libappcontroller - src_prefix: docs - dst_prefix: ctrler - documents: - - source: Usage.md - label: Usage - - source: configSample.md - label: Configuration Sample - - source: controller.md - label: Installation - - source: controllerConfig.md - label: Binding Configuration -- - git_name: src/libafb-helpers - src_prefix: docs - dst_prefix: afb-helpers - documents: - - source: usage.md - label: Usage - - source: afb-timer.md - label: AFB Timer - - source: curl-wrap.md - label: CURL wrapper - - source: escape.md - label: URL escaping - - source: filescan-utils.md - label: Filescan Utils - - source: qafbwebsocketclient.md - label: Qt AFB Websocket client - - source: json.md - label: JSON library for modern C++ - - source: wrap-json.md - label: C JSON Wrapper diff --git a/content/tocs/devguides/section_flounder.yml b/content/tocs/devguides/section_flounder.yml new file mode 100644 index 0000000..a18fb37 --- /dev/null +++ b/content/tocs/devguides/section_flounder.yml @@ -0,0 +1,66 @@ +url_fetch : "GERRIT_FETCH" +git_commit : "flounder" + +name: Developers Guides +template: generated_index.html +books: +- + id: meta-agl-developer-guides-flounder + git_name: AGL/meta-agl + path: docs/devguides-book.yml + brotherBooks: + - + id: meta-agl-demo-guides-flounder + git_name: AGL/meta-agl-demo + path: docs/devguides-book.yml + - + id: meta-agl-devel-guides-flounder + git_name: AGL/meta-agl-devel + path: docs/devguides-book.yml +- + id: host-configuration-developer-guides-flounder + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: iotbzh/agl-documentation + git_commit: master + path: host-configuration/docs/devguides-book.yml +- + id: app-templates-guides-flounder + git_name: apps/app-templates + path: docs/devguides-book.yml + dst_prefix: "2_4-Use-app-templates.md" +- + id: xds-docs-guides-flounder + 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: app-controller-submodule-guides-flounder + git_name: apps/app-controller-submodule + path: docs/devguides-book.yml + dst_prefix: ctrler +- + 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://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/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 + 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 new file mode 100644 index 0000000..7408b41 --- /dev/null +++ b/content/tocs/devguides/section_guppy.yml @@ -0,0 +1,68 @@ +url_fetch : "GERRIT_FETCH" + +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_commit: master + 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: app-controller-submodule-guides + git_name: apps/app-controller-submodule + 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 + git_commit: master + path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/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 + name: How to write tests (detailed) diff --git a/content/tocs/devguides/section_master.yml b/content/tocs/devguides/section_master.yml new file mode 100644 index 0000000..cfe3089 --- /dev/null +++ b/content/tocs/devguides/section_master.yml @@ -0,0 +1,65 @@ +url_fetch : "GERRIT_FETCH" + +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: app-controller-submodule-guides + git_name: apps/app-controller-submodule + 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://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/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 + name: How to write tests (detailed) diff --git a/content/tocs/devguides/toc_dev_en.yml b/content/tocs/devguides/toc_dev_en.yml index 3c99142..551ae12 100644 --- a/content/tocs/devguides/toc_dev_en.yml +++ b/content/tocs/devguides/toc_dev_en.yml @@ -39,7 +39,7 @@ name: Developer Guides template: generated_index.html children: - - name: Yocto layers + name: AGL layers children: - url: reference/AGL.html - url: reference/meta-agl.html |