From ab747d6bd667baf087ff39daabd56703b1c938b6 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 25 Oct 2018 15:13:46 -0700 Subject: YAML files for application development flow section Created TOC and fetch information for a new "Application Development Workflow" section. The section sits in the existing "Getting Started" area for now. Signed-off-by: Scott Rifenbark --- content/tocs/getting_started/fetched_files.yml | 20 ++++++++++++++++++++ content/tocs/getting_started/toc_dev_en.yml | 25 ++++++++++++++++++++----- 2 files changed, 40 insertions(+), 5 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/getting_started/fetched_files.yml b/content/tocs/getting_started/fetched_files.yml index 4b7b551..62e7fbe 100644 --- a/content/tocs/getting_started/fetched_files.yml +++ b/content/tocs/getting_started/fetched_files.yml @@ -48,6 +48,26 @@ repositories: git_commit: master-next src_prefix : docs/getting-started documents : + - source: app-workflow-intro.md + label: Overview + - source: app-workflow-image.md + label: Download or Build Your Image + - source: app-workflow-sdk.md + label: Download or Build Your SDK Installer + - source: app-workflow-bootables.md + label: Create Bootable Media + - source: app-workflow-boot.md + label: Boot the Image on the Board + - source: app-workflow-prep-app.md + label: Get Ready to Create Your Application + - source: app-workflow-build-app.md + label: Create and Build the Application + - source: app-workflow-deploy-app.md + label: Deploy the Application to the Board + - source: app-workflow-debug-app.md + label: Debug the Application + - source: images/app-developer-workflow.png + destination: images/app-developer-workflow.png - source: source-code.md label: Download AGL Source Code - source: customize_bitbake_conf.md diff --git a/content/tocs/getting_started/toc_dev_en.yml b/content/tocs/getting_started/toc_dev_en.yml index a534c61..38f8154 100644 --- a/content/tocs/getting_started/toc_dev_en.yml +++ b/content/tocs/getting_started/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: Date: Tue, 13 Nov 2018 15:46:49 -0800 Subject: Image Workflow Files and TOC (YAML Updates) These are the updates for the new Image Workflow section to create the TOC nav topics and fetch the correct files. Signed-off-by: Scott Rifenbark --- content/tocs/getting_started/fetched_files.yml | 21 ++++++++++++++++----- content/tocs/getting_started/toc_dev_en.yml | 10 +++++++--- 2 files changed, 23 insertions(+), 8 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/getting_started/fetched_files.yml b/content/tocs/getting_started/fetched_files.yml index 62e7fbe..8123b45 100644 --- a/content/tocs/getting_started/fetched_files.yml +++ b/content/tocs/getting_started/fetched_files.yml @@ -68,18 +68,28 @@ repositories: label: Debug the Application - source: images/app-developer-workflow.png destination: images/app-developer-workflow.png - - source: source-code.md - label: Download AGL Source Code - - source: customize_bitbake_conf.md - label: Customize the AGL build + - source: image-workflow-intro.md + label: Overview + - source: image-workflow-prep-host.md + label: Preparing Your Build Host + - source: image-workflow-download-sw.md + label: Downloading AGL Software + - source: image-workflow-initialize-build-environment.md + label: Initializing Your Build Environment + - source: image-workflow-cust-build.md + label: Customizing Your Build + - source: image-workflow-build.md + label: Building the AGL Image - source: machines/intel.md - label: Build for Intel + label: Building for Most Intel 64-Bit Hardware Platforms - source: machines/qemu.md label: Build for Qemu - 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: images/image-developer-workflow.png + destination: images/image-developer-workflow.png - source: troubleshooting.md label: Generic issues - source: footers/intel-footer.md @@ -109,4 +119,5 @@ repositories: destination: pictures/phone.png - source: pictures/settings.png destination: pictures/settings.png + - source: pictures/image-developer-workflow.png diff --git a/content/tocs/getting_started/toc_dev_en.yml b/content/tocs/getting_started/toc_dev_en.yml index 38f8154..89af391 100644 --- a/content/tocs/getting_started/toc_dev_en.yml +++ b/content/tocs/getting_started/toc_dev_en.yml @@ -39,10 +39,14 @@ name: Getting started template: generated_index.html children: - - name: Getting Started + name: Image Development Workflow children: - - url: reference/source-code.html - - url: reference/customize_bitbake_conf.html + - url: reference/image-workflow-intro.html + - url: reference/image-workflow-prep-host.html + - url: reference/image-workflow-download-sw.html + - url: reference/image-workflow-initialize-build-environment.html + - url: reference/image-workflow-cust-build.html + - url: reference/image-workflow-build.html - url: reference/machines/intel.html - url: reference/machines/qemu.html - url: reference/machines/R-Car-Starter-Kit-gen3.html -- cgit From 16f3a77f6c099396107f672fad0b9aca444b5a21 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 16 Nov 2018 14:26:39 -0800 Subject: Updated Title for Building for Emulation. The content is more about building for emulation and not just for QEMU. I updated the TOC title to reflect that. Signed-off-by: Scott Rifenbark --- content/tocs/getting_started/fetched_files.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'content/tocs') diff --git a/content/tocs/getting_started/fetched_files.yml b/content/tocs/getting_started/fetched_files.yml index 8123b45..3cc3847 100644 --- a/content/tocs/getting_started/fetched_files.yml +++ b/content/tocs/getting_started/fetched_files.yml @@ -83,7 +83,7 @@ repositories: - source: machines/intel.md label: Building for Most Intel 64-Bit Hardware Platforms - source: machines/qemu.md - label: Build for Qemu + label: Building for Emulation - source: machines/R-Car-Starter-Kit-gen3.md label: Build for R Car Starter Kit gen3 board - source: machines/raspberrypi.md -- cgit From 9661bbba26f9d9e42b9e60ae2d028e10dbe4ee7a Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Wed, 14 Nov 2018 10:45:13 +0100 Subject: new generation workflow: deported yaml files MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The first new generation workflow, it allows to deported yaml files into remote repositories. Please see documentation at https://github.com/automotive-grade-linux/docs-tools/blob/master-next/docs/NextGenWorkflow.pdf New yaml files are named "section_.yml" and point to the deported yaml files named "book<...>.yaml" from remote repositories. Signed-off-by: Clément Bénier --- content/tocs/apis_services/section_master.yml | 11 +++++++++++ content/tocs/getting_started/section_master.yml | 15 +++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 content/tocs/apis_services/section_master.yml create mode 100644 content/tocs/getting_started/section_master.yml (limited to 'content/tocs') diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml new file mode 100644 index 0000000..455117d --- /dev/null +++ b/content/tocs/apis_services/section_master.yml @@ -0,0 +1,11 @@ +url_fetch : "GERRIT_FETCH" +git_commit : "AGL_GERRIT_BRANCH" + +name: Developer Guides +template: generated_index.html +books: +- + id: app-framework-binder-apis-services + url_fetch : "https://git.automotivelinux.org/src/app-framework-binder/plain/docs/app-framework-binder-book.yml?h=sandbox/benierc/newdocs" + path: docs/app-framework-binder-book.yml + diff --git a/content/tocs/getting_started/section_master.yml b/content/tocs/getting_started/section_master.yml new file mode 100644 index 0000000..e65b474 --- /dev/null +++ b/content/tocs/getting_started/section_master.yml @@ -0,0 +1,15 @@ +url_fetch : "AGL_GITHUB_FETCH" +url_edit : "AGL_GITHUB_EDIT" +git_commit : "AGL_GITHUB_BRANCH" + +name: Getting started +template: generated_index.html +books: +- + id: docs-source-getting-started + url_fetch: "https://raw.githubusercontent.com/benierc/docs-sources/master/%source%" + path: docs/getting-started-book.yml +- + id: homescreen + url_fetch : "https://git.automotivelinux.org/apps/homescreen/plain/homescreen/docs/homescreen-book.yml?h=sandbox/benierc/newdocs" + path: homescreen/docs/homescreen-book.yml -- cgit From cde6cb1f1be5982b9d4e20c54072b21700f6e5dd Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Sun, 18 Nov 2018 23:21:02 +0100 Subject: new api service book MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/apis_services/section_master.yml | 8 +++++++- content/tocs/getting_started/section_master.yml | 3 ++- 2 files changed, 9 insertions(+), 2 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml index 455117d..d35c64b 100644 --- a/content/tocs/apis_services/section_master.yml +++ b/content/tocs/apis_services/section_master.yml @@ -8,4 +8,10 @@ books: id: app-framework-binder-apis-services url_fetch : "https://git.automotivelinux.org/src/app-framework-binder/plain/docs/app-framework-binder-book.yml?h=sandbox/benierc/newdocs" path: docs/app-framework-binder-book.yml - +- id: message-signaling + url_fetch: "https://raw.githubusercontent.com/benierc/docs-sources/master/%source%" + path: docs/signaling-book.yml + books: + - id: high-level-viwi + url_fetch: "https://raw.githubusercontent.com/benierc/high-level-viwi-service/master/%source%" + path: docs/high-level-viwi-book.yml diff --git a/content/tocs/getting_started/section_master.yml b/content/tocs/getting_started/section_master.yml index e65b474..35f39ea 100644 --- a/content/tocs/getting_started/section_master.yml +++ b/content/tocs/getting_started/section_master.yml @@ -7,7 +7,8 @@ template: generated_index.html books: - id: docs-source-getting-started - url_fetch: "https://raw.githubusercontent.com/benierc/docs-sources/master/%source%" + git_name: "automotive-grade-linux/docs-sources" + git_commit: master-next path: docs/getting-started-book.yml - id: homescreen -- cgit From f46cd43b895fd6d353e948b80bff3602781cf84e Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 23 Nov 2018 11:37:09 -0800 Subject: getting started: Updated the fetch and toc YAML files for renesas The changes to the file name and title for the section on building for R-Car changed. I updated the files to reflect the changes. Signed-off-by: Scott Rifenbark --- content/tocs/getting_started/fetched_files.yml | 4 ++-- content/tocs/getting_started/toc_dev_en.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/getting_started/fetched_files.yml b/content/tocs/getting_started/fetched_files.yml index 3cc3847..b9ef03c 100644 --- a/content/tocs/getting_started/fetched_files.yml +++ b/content/tocs/getting_started/fetched_files.yml @@ -84,8 +84,8 @@ repositories: label: Building for Most Intel 64-Bit Hardware Platforms - source: machines/qemu.md label: Building for Emulation - - source: machines/R-Car-Starter-Kit-gen3.md - label: Build for R Car Starter Kit gen3 board + - source: machines/renesas.md + label: Building for Supported Renesas Boards - source: machines/raspberrypi.md label: Build for Raspberry PI 2/3 - source: images/image-developer-workflow.png diff --git a/content/tocs/getting_started/toc_dev_en.yml b/content/tocs/getting_started/toc_dev_en.yml index 89af391..2049f8f 100644 --- a/content/tocs/getting_started/toc_dev_en.yml +++ b/content/tocs/getting_started/toc_dev_en.yml @@ -49,7 +49,7 @@ children: - url: reference/image-workflow-build.html - url: reference/machines/intel.html - url: reference/machines/qemu.html - - url: reference/machines/R-Car-Starter-Kit-gen3.html + - url: reference/machines/renesas.html - url: reference/machines/raspberrypi.html - name: HomeScreen -- cgit From 83b547e656e0395c851617be6bdb66ef682ecd2a Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 26 Nov 2018 14:03:29 -0800 Subject: Raspberry PI: Updated title. Updated the "fetched_files.yml" file to have a better section heading. Signed-off-by: Scott Rifenbark --- content/tocs/getting_started/fetched_files.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'content/tocs') diff --git a/content/tocs/getting_started/fetched_files.yml b/content/tocs/getting_started/fetched_files.yml index b9ef03c..e6b5c3c 100644 --- a/content/tocs/getting_started/fetched_files.yml +++ b/content/tocs/getting_started/fetched_files.yml @@ -87,7 +87,7 @@ repositories: - source: machines/renesas.md label: Building for Supported Renesas Boards - source: machines/raspberrypi.md - label: Build for Raspberry PI 2/3 + label: Building for Raspberry PI 2 or 3 - source: images/image-developer-workflow.png destination: images/image-developer-workflow.png - source: troubleshooting.md -- cgit From 73d78b467bc5e10ace5b8b775d29511773b5fd49 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 27 Nov 2018 10:17:39 -0800 Subject: API Landing Page: Added information for new API landing page Updated the "fetched_files.yml" and "toc_dev_en.yml" files so that a new landing page exists for the API reference. Signed-off-by: Scott Rifenbark --- content/tocs/apis_services/fetched_files.yml | 2 ++ content/tocs/apis_services/toc_dev_en.yml | 43 ++++++++++++++++------------ 2 files changed, 27 insertions(+), 18 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml index 95c2dcf..a554f57 100644 --- a/content/tocs/apis_services/fetched_files.yml +++ b/content/tocs/apis_services/fetched_files.yml @@ -49,6 +49,8 @@ repositories: documents: - source: 0-introduction.md label: Introduction + - source: 0-kristi-introduction.md + label: API Reference - source: 1-afm-daemons.md label: The afm daemons - source: 2-widgets.md diff --git a/content/tocs/apis_services/toc_dev_en.yml b/content/tocs/apis_services/toc_dev_en.yml index 56cc4f3..1d16069 100644 --- a/content/tocs/apis_services/toc_dev_en.yml +++ b/content/tocs/apis_services/toc_dev_en.yml @@ -38,6 +38,11 @@ name: Developer Guides template: generated_index.html children: +- + name: API Reference + children: + - url: reference/af-main/0-kristi-introduction.html + - name: Application Framework children: @@ -80,24 +85,27 @@ children: name: AGL Test Framework children: - url: reference/afb-test/Installation.html - - url: reference/afb-test/write-the-tests.html - - url: reference/afb-test/the-test-widget.html - - url: reference/afb-test/launch-the-tests.html - - url: reference/afb-test/tests-examples.html - - name: References + - url: reference/afb-test/test-example.html + - url: reference/afb-test/launch-the-example.html + - name: Write Your Tests children: - - url: reference/afb-test/binding-test-functions.html - - url: reference/afb-test/binding-assert-functions.html - - url: reference/afb-test/test-framework-functions.html - - name: LuaUnit Assertion Functions - children: - - url: reference/afb-test/general-assertions.html - - url: reference/afb-test/value-assertions.html - - url: reference/afb-test/scientific-assertions.html - - url: reference/afb-test/string-assertions.html - - url: reference/afb-test/error-assertions.html - - url: reference/afb-test/type-assertions.html - - url: reference/afb-test/table-assertions.html + - url: reference/afb-test/project-tree.html + - url: reference/afb-test/binding-configuration.html + - url: reference/afb-test/Lua-test-files.html + - name: References + children: + - url: reference/afb-test/binding-test-functions.html + - url: reference/afb-test/binding-assert-functions.html + - url: reference/afb-test/test-framework-functions.html + - name: LuaUnit Assertion Functions + children: + - url: reference/afb-test/general-assertions.html + - url: reference/afb-test/value-assertions.html + - url: reference/afb-test/scientific-assertions.html + - url: reference/afb-test/string-assertions.html + - url: reference/afb-test/error-assertions.html + - url: reference/afb-test/type-assertions.html + - url: reference/afb-test/table-assertions.html - name: Message Signaling @@ -172,4 +180,3 @@ children: children: - url: reference/homescreen/homescreen_api.html - -- cgit From 92d7de2575d46ec704e2a6e4e10022336df5a40c Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 4 Dec 2018 17:53:08 -0800 Subject: Containers: Changed the "Quick SDK Setup" section to "Containers" This section is more about setting up a container after installing Docker. I have renamed files, sections, etc. appropriately. Signed-off-by: Scott Rifenbark --- content/tocs/getting_started/fetched_files.yml | 4 ++-- content/tocs/getting_started/toc_dev_en.yml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/getting_started/fetched_files.yml b/content/tocs/getting_started/fetched_files.yml index e6b5c3c..02cf878 100644 --- a/content/tocs/getting_started/fetched_files.yml +++ b/content/tocs/getting_started/fetched_files.yml @@ -98,8 +98,8 @@ repositories: 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 + - source: docker-container-setup.md + label: Setting Up a Docker Container - url_fetch : GERRIT_FETCH git_name : apps/homescreen diff --git a/content/tocs/getting_started/toc_dev_en.yml b/content/tocs/getting_started/toc_dev_en.yml index 2049f8f..6bb5dcc 100644 --- a/content/tocs/getting_started/toc_dev_en.yml +++ b/content/tocs/getting_started/toc_dev_en.yml @@ -62,9 +62,9 @@ children: - url: reference/footers/intel-footer.html - url: reference/footers/raspberrypi-footer.html - - name: SDK + name: Docker Containers children: - - url: reference/setup-sdk-environment.html + - url: reference/docker-container-setup.html - # name: Scott's new section so far # children: -- cgit From 3b378aa49fbe91da3f144ad74087bd4771068729 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Thu, 6 Dec 2018 18:00:18 +0100 Subject: fetched_files: fix 404 error MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/apis_services/fetched_files.yml | 11 +++++++---- content/tocs/devguides/fetched_files.yml | 2 +- content/tocs/getting_started/fetched_files.yml | 3 +-- 3 files changed, 9 insertions(+), 7 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml index a554f57..a279a5e 100644 --- a/content/tocs/apis_services/fetched_files.yml +++ b/content/tocs/apis_services/fetched_files.yml @@ -279,7 +279,7 @@ repositories: - source: images/distributed-arch.png - source: images/signal-service-arch.svg - - url_fetch: http://iot.bzh/download/public/2016/%source% + url_fetch: https://iot.bzh/download/public/2016/%source% dst_prefix: iotbzh2016 documents: - source: signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf @@ -340,12 +340,15 @@ repositories: - 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/showInformation.svg + - source: parts/showNotification.svg + - source: parts/showOnScreen.svg + - source: parts/showWindow.svg - source: parts/software-stack.png - source: parts/tap_shortcut.svg + - url_fetch: "GERRIT_FETCH" git_name: apps/agl-service-windowmanager @@ -357,7 +360,7 @@ repositories: destination: 3_2-WindowManager-Guide.md label: Window Manager Developper Guide - source: parts/deactivate_window.png - - source: parts/software-stack.png + - source: parts/wm_software_stack.png - source: parts/example_split.png - source: parts/state_change_example.png - source: parts/hmi_framework_designed_seq_toyota.png diff --git a/content/tocs/devguides/fetched_files.yml b/content/tocs/devguides/fetched_files.yml index 2d6efe8..6785d1b 100644 --- a/content/tocs/devguides/fetched_files.yml +++ b/content/tocs/devguides/fetched_files.yml @@ -62,7 +62,7 @@ repositories: destination: meta-agl-devel.md label: meta-agl-devel - - url_fetch: http://iot.bzh/download/public/2016/%source% + url_fetch: https://iot.bzh/download/public/2016/%source% dst_prefix: iotbzh2016 documents: - source: 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 index 02cf878..53e4c71 100644 --- a/content/tocs/getting_started/fetched_files.yml +++ b/content/tocs/getting_started/fetched_files.yml @@ -96,7 +96,7 @@ repositories: label: Intel Boards - source: footers/raspberrypi-footer.md label: Raspberry PI - - source: images/RaspberryPi2-ModelB-debug-serial-cable.jpg + - source: footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpg destination: footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpg - source: docker-container-setup.md label: Setting Up a Docker Container @@ -119,5 +119,4 @@ repositories: destination: pictures/phone.png - source: pictures/settings.png destination: pictures/settings.png - - source: pictures/image-developer-workflow.png -- cgit From 85d015213b015ec82d102ccfcbae0c6c4669978e Mon Sep 17 00:00:00 2001 From: Stéphane Desneux Date: Thu, 6 Dec 2018 19:51:01 +0100 Subject: tocs: forward port from master branch MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit ports the adjustments recently made on master branch to the master-next branch, while keeping changes related to doc reorganization. Change-Id: I3d222bba1151bf0dd9136bed95a88bb2de9bdc24 Signed-off-by: Stéphane Desneux --- content/tocs/apis_services/fetched_files.yml | 100 +++++++++++------------- content/tocs/apis_services/toc_dev_en.yml | 39 +++++---- content/tocs/architecture/fetched_files.yml | 22 +++--- content/tocs/devguides/fetched_files.yml | 30 ++++--- content/tocs/getting_started/fetched_files.yml | 28 +++---- content/tocs/getting_started/section_master.yml | 2 +- content/tocs/hardware/fetched_files.yml | 11 +-- 7 files changed, 113 insertions(+), 119 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml index a279a5e..f1709a0 100644 --- a/content/tocs/apis_services/fetched_files.yml +++ b/content/tocs/apis_services/fetched_files.yml @@ -5,8 +5,8 @@ # # 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) +# 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% @@ -37,14 +37,13 @@ # ------------------------------------ ############################################################################################################## -url_fetch : "GERRIT_FETCH" -git_commit : "AGL_GERRIT_BRANCH" +url_fetch: GERRIT_FETCH +git_commit: AGL_GERRIT_BRANCH repositories: - - git_name : src/app-framework-main - git_commit: master - src_prefix : docs + git_name: src/app-framework-main + src_prefix: docs dst_prefix: af-main documents: - source: 0-introduction.md @@ -70,9 +69,8 @@ repositories: - source: pictures/triskel_iot_bzh.svg - - git_name : src/app-framework-binder - git_commit: master - src_prefix : docs + git_name: src/app-framework-binder + src_prefix: docs dst_prefix: af-binder documents: - source: index.md @@ -129,9 +127,8 @@ repositories: - source: pictures/triskel_iot_bzh.svg - - git_name : apps/agl-service-can-low-level - git_commit: master - src_prefix : docs + git_name: apps/agl-service-can-low-level + src_prefix: docs dst_prefix: signaling documents: - source: 1-Architecture.md @@ -148,9 +145,8 @@ repositories: - source: images/OpenXC_to_AGL.png - - git_name : apps/app-afb-test - git_commit: master - src_prefix : docs + git_name: apps/app-afb-test + src_prefix: docs dst_prefix: afb-test documents: - source: 0_Installation.md @@ -201,9 +197,10 @@ repositories: - url_fetch: GITHUB_FETCH - git_name : iotbzh/high-level-viwi-service + url_edit: GITHUB_EDIT + git_name: iotbzh/high-level-viwi-service git_commit: master - src_prefix : docs + src_prefix: docs dst_prefix: signaling documents: - source: 1-Architecture.md @@ -214,9 +211,7 @@ repositories: label: Installation and Usage Guide - source: images/high-level-arch.png - - url_fetch: "GERRIT_FETCH" git_name: apps/agl-service-signal-composer - git_commit: "master" src_prefix: docs/part-1/ dst_prefix: signaling documents: @@ -235,9 +230,10 @@ repositories: - source: pictures/Global_Signaling_Architecture.png - source: pictures/iotbzh_logo_small.png - - url_fetch: "GITHUB_FETCH" + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT git_name: iotbzh/agl-documentation - git_commit: "master" + git_commit: master documents: - source: candevstudio/docs/1_Usage.md - source: candevstudio/docs/2_can_device_socketcan_backend.md @@ -250,8 +246,9 @@ repositories: - url_fetch: AGL_GITHUB_FETCH - git_name: "automotive-grade-linux/docs-sources" - git_commit: master-next + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + git_commit: AGL_GITHUB_BRANCH src_prefix: docs/app-framework dst_prefix: af-binder documents: @@ -260,8 +257,9 @@ repositories: label: Resources - url_fetch: AGL_GITHUB_FETCH - git_name: "automotive-grade-linux/docs-sources" - git_commit: master-next + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + git_commit: AGL_GITHUB_BRANCH src_prefix: docs/signaling dst_prefix: signaling documents: @@ -287,8 +285,8 @@ repositories: - url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_name: "automotive-grade-linux/docs-sources" - git_commit: master-next + git_name: automotive-grade-linux/docs-sources + git_commit: AGL_GITHUB_BRANCH src_prefix: docs/audio dst_prefix: audio documents: @@ -299,10 +297,8 @@ repositories: destination: bluez-alsa.md label: bluez-alsa - - url_fetch: "GERRIT_FETCH" - git_commit : "AGL_GERRIT_BRANCH" git_name: apps/agl-service-audio-4a - src_prefix : docs + src_prefix: docs dst_prefix: audio documents: - source: 4a-framework/README.md @@ -331,46 +327,46 @@ repositories: - source: high-level-api/TipsAndTricks/images/changeSound.png - source: high-level-api/TipsAndTricks/images/MixerBaseMenu.png - - url_fetch: "GERRIT_FETCH" + git_name: src/pulseaudio-module-4a + dst_prefix: audio + documents: + - source: README.md + destination: pulseaudio-module-4a.md + label: Pulseaudio - 4A Integration Module +- git_name: apps/agl-service-homescreen - 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/software-stack.png - source: parts/initialize-set-event-handler.svg + - source: parts/tap_shortcut.svg + - source: parts/showWindow.svg - source: parts/on_screen_message.svg - - source: parts/showInformation.svg - - source: parts/showNotification.svg - source: parts/showOnScreen.svg - - source: parts/showWindow.svg - - source: parts/software-stack.png - - source: parts/tap_shortcut.svg - + - source: parts/showNotification.svg + - source: parts/showInformation.svg - - url_fetch: "GERRIT_FETCH" git_name: apps/agl-service-windowmanager - 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 - - source: parts/deactivate_window.png - - source: parts/wm_software_stack.png - - source: parts/example_split.png - source: parts/state_change_example.png - - source: parts/hmi_framework_designed_seq_toyota.png + - source: parts/wm_software_stack.png + - source: parts/wm_layer_stack.png - source: parts/wm_area.png - source: parts/request_role.png - - source: parts/wm_layer_stack.png + - source: parts/hmi_framework_designed_seq_toyota.png + - source: parts/deactivate_window.png + - source: parts/example_split.png - - url_fetch: "GERRIT_FETCH" git_name: apps/agl-service-soundmanager - git_commit: "master" src_prefix: doc/ dst_prefix: hmi-framework/ documents: @@ -398,11 +394,9 @@ repositories: - source: parts/typical-usecase.png - source: parts/am-component.png - - url_fetch : GERRIT_FETCH - git_commit : master - git_name : apps/homescreen - src_prefix : homescreen/docs - dst_prefix : homescreen + git_name: apps/homescreen + src_prefix: homescreen/docs + dst_prefix: homescreen documents: - source: homescreen_api.md label: HomeScreen API diff --git a/content/tocs/apis_services/toc_dev_en.yml b/content/tocs/apis_services/toc_dev_en.yml index 1d16069..023e699 100644 --- a/content/tocs/apis_services/toc_dev_en.yml +++ b/content/tocs/apis_services/toc_dev_en.yml @@ -85,27 +85,24 @@ children: name: AGL Test Framework children: - url: reference/afb-test/Installation.html - - url: reference/afb-test/test-example.html - - url: reference/afb-test/launch-the-example.html - - name: Write Your Tests + - url: reference/afb-test/write-the-tests.html + - url: reference/afb-test/the-test-widget.html + - url: reference/afb-test/launch-the-tests.html + - url: reference/afb-test/tests-examples.html + - name: References children: - - url: reference/afb-test/project-tree.html - - url: reference/afb-test/binding-configuration.html - - url: reference/afb-test/Lua-test-files.html - - name: References - children: - - url: reference/afb-test/binding-test-functions.html - - url: reference/afb-test/binding-assert-functions.html - - url: reference/afb-test/test-framework-functions.html - - name: LuaUnit Assertion Functions - children: - - url: reference/afb-test/general-assertions.html - - url: reference/afb-test/value-assertions.html - - url: reference/afb-test/scientific-assertions.html - - url: reference/afb-test/string-assertions.html - - url: reference/afb-test/error-assertions.html - - url: reference/afb-test/type-assertions.html - - url: reference/afb-test/table-assertions.html + - url: reference/afb-test/binding-test-functions.html + - url: reference/afb-test/binding-assert-functions.html + - url: reference/afb-test/test-framework-functions.html + - name: LuaUnit Assertion Functions + children: + - url: reference/afb-test/general-assertions.html + - url: reference/afb-test/value-assertions.html + - url: reference/afb-test/scientific-assertions.html + - url: reference/afb-test/string-assertions.html + - url: reference/afb-test/error-assertions.html + - url: reference/afb-test/type-assertions.html + - url: reference/afb-test/table-assertions.html - name: Message Signaling @@ -147,6 +144,7 @@ children: name: Audio Framework children: - url: reference/audio/bluez-alsa.html + - url: reference/audio/pulseaudio-module-4a.html - name: 4a Framework children: - url: reference/audio/4a-framework/README.html @@ -180,3 +178,4 @@ children: children: - url: reference/homescreen/homescreen_api.html + diff --git a/content/tocs/architecture/fetched_files.yml b/content/tocs/architecture/fetched_files.yml index 5903a18..b57d5d2 100644 --- a/content/tocs/architecture/fetched_files.yml +++ b/content/tocs/architecture/fetched_files.yml @@ -5,8 +5,8 @@ # # 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) +# 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% @@ -37,11 +37,11 @@ # ------------------------------------ ############################################################################################################## -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) +#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: - @@ -51,9 +51,11 @@ repositories: - source: agl_spec_v1.0_final.pdf - - git_name : "automotive-grade-linux/docs-sources" - git_commit: master-next - src_prefix : docs/security-blueprint + 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 diff --git a/content/tocs/devguides/fetched_files.yml b/content/tocs/devguides/fetched_files.yml index 6785d1b..2d9d6d3 100644 --- a/content/tocs/devguides/fetched_files.yml +++ b/content/tocs/devguides/fetched_files.yml @@ -5,8 +5,8 @@ # # 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) +# 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% @@ -37,8 +37,9 @@ # ------------------------------------ ############################################################################################################## -url_fetch : "GERRIT_FETCH" -git_commit: "AGL_GERRIT_BRANCH" +url_fetch: GERRIT_FETCH +git_commit: AGL_GERRIT_BRANCH + repositories: - git_name: AGL/meta-agl @@ -67,9 +68,10 @@ repositories: documents: - source: appfw/03-AGL-AppFW-Privileges-Management.pdf - - url_fetch: "GITHUB_FETCH" + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT git_name: iotbzh/agl-documentation - git_commit: "master" + git_commit: master documents: - source: host-configuration/docs/0_Abstract.md - source: host-configuration/docs/1_Prerequisites.md @@ -78,9 +80,10 @@ repositories: - source: host-configuration/docs/4_AGL_XDS.md - source: host-configuration/docs/5_Candevstudio.md - - url_fetch: "GITHUB_FETCH" + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT git_name: iotbzh/agl-documentation - git_commit: "master" + 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 @@ -118,9 +121,7 @@ repositories: - 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: src/cmake-apps-module - git_commit: "master" src_prefix: "docs/dev_guide" dst_prefix: "cmakeafbtemplates" documents: @@ -131,9 +132,7 @@ repositories: - source: 4_advanced_customization.md - source: 5_autobuild.md - - url_fetch: "GERRIT_FETCH" git_name: src/xds/xds-docs - git_commit: "master" src_prefix: "docs" dst_prefix: "xds" documents: @@ -195,16 +194,15 @@ repositories: - source: part-2/4_xds-gdb/3_debug.md - - url_fetch: "GITHUB_FETCH" + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT git_name: baylibre/agl-docs-baylibre - git_commit: "master" + git_commit: master documents: - source: CIAT/training/How_to_write_your_own_tests_for_AGL.pdf - source: CIAT/training/Hands_on_lab_documentation.pdf - - url_fetch: "GERRIT_FETCH" git_name: apps/app-controller-submodule - git_commit: master src_prefix: docs dst_prefix: ctrler documents: diff --git a/content/tocs/getting_started/fetched_files.yml b/content/tocs/getting_started/fetched_files.yml index 53e4c71..4113447 100644 --- a/content/tocs/getting_started/fetched_files.yml +++ b/content/tocs/getting_started/fetched_files.yml @@ -5,8 +5,8 @@ # # 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) +# 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% @@ -37,16 +37,18 @@ # ------------------------------------ ############################################################################################################## -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) +#dst_prefix: # destination_path = destination_prefix + (document.destination || document.source) + +url_fetch: GERRIT_FETCH +git_commit: AGL_GERRIT_BRANCH repositories: - - git_name : "automotive-grade-linux/docs-sources" - git_commit: master-next - src_prefix : docs/getting-started + 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/getting-started documents : - source: app-workflow-intro.md label: Overview @@ -101,11 +103,9 @@ repositories: - source: docker-container-setup.md label: Setting Up a Docker Container - - url_fetch : GERRIT_FETCH - git_name : apps/homescreen - git_commit : AGL_GERRIT_BRANCH - src_prefix : homescreen/docs - dst_prefix : homescreen + git_name: apps/homescreen + src_prefix: homescreen/docs + dst_prefix: homescreen documents: - source: index.md label: Overview diff --git a/content/tocs/getting_started/section_master.yml b/content/tocs/getting_started/section_master.yml index 35f39ea..b6e663c 100644 --- a/content/tocs/getting_started/section_master.yml +++ b/content/tocs/getting_started/section_master.yml @@ -8,7 +8,7 @@ books: - id: docs-source-getting-started git_name: "automotive-grade-linux/docs-sources" - git_commit: master-next + git_commit: AGL_GITHUB_BRANCH path: docs/getting-started-book.yml - id: homescreen diff --git a/content/tocs/hardware/fetched_files.yml b/content/tocs/hardware/fetched_files.yml index 9e0a5ec..f1decf7 100644 --- a/content/tocs/hardware/fetched_files.yml +++ b/content/tocs/hardware/fetched_files.yml @@ -5,8 +5,8 @@ # # 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) +# 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% @@ -37,9 +37,10 @@ # ------------------------------------ ############################################################################################################## -url_fetch : "GERRIT_FETCH" -git_commit : "AGL_GERRIT_BRANCH" -#dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) +#dst_prefix: # destination_path = destination_prefix + (document.destination || document.source) + +url_fetch: "GERRIT_FETCH" +git_commit: "AGL_GERRIT_BRANCH" repositories: - -- cgit From 8d4251a3c71f0dca1c6c9a51ee0e6f9ad32db171 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Sun, 25 Nov 2018 17:10:08 +0100 Subject: content/getting_started: add section_flounder.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/getting_started/section_flounder.yml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 content/tocs/getting_started/section_flounder.yml (limited to 'content/tocs') diff --git a/content/tocs/getting_started/section_flounder.yml b/content/tocs/getting_started/section_flounder.yml new file mode 100644 index 0000000..35f39ea --- /dev/null +++ b/content/tocs/getting_started/section_flounder.yml @@ -0,0 +1,16 @@ +url_fetch : "AGL_GITHUB_FETCH" +url_edit : "AGL_GITHUB_EDIT" +git_commit : "AGL_GITHUB_BRANCH" + +name: Getting started +template: generated_index.html +books: +- + id: docs-source-getting-started + git_name: "automotive-grade-linux/docs-sources" + git_commit: master-next + path: docs/getting-started-book.yml +- + id: homescreen + url_fetch : "https://git.automotivelinux.org/apps/homescreen/plain/homescreen/docs/homescreen-book.yml?h=sandbox/benierc/newdocs" + path: homescreen/docs/homescreen-book.yml -- cgit From 7e5900aa50d2be2362575e662c153f1e49c04f64 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Wed, 12 Dec 2018 09:35:37 +0100 Subject: new yaml files MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/apis_services/section_master.yml | 79 ++++++++++++++++++++--- content/tocs/apis_services/toc_dev_en.yml | 2 +- content/tocs/getting_started/section_flounder.yml | 16 ----- content/tocs/getting_started/section_master.yml | 16 ----- 4 files changed, 70 insertions(+), 43 deletions(-) delete mode 100644 content/tocs/getting_started/section_flounder.yml delete mode 100644 content/tocs/getting_started/section_master.yml (limited to 'content/tocs') diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml index d35c64b..6bfaf6b 100644 --- a/content/tocs/apis_services/section_master.yml +++ b/content/tocs/apis_services/section_master.yml @@ -5,13 +5,72 @@ name: Developer Guides template: generated_index.html books: - - id: app-framework-binder-apis-services - url_fetch : "https://git.automotivelinux.org/src/app-framework-binder/plain/docs/app-framework-binder-book.yml?h=sandbox/benierc/newdocs" - path: docs/app-framework-binder-book.yml -- id: message-signaling - url_fetch: "https://raw.githubusercontent.com/benierc/docs-sources/master/%source%" - path: docs/signaling-book.yml - books: - - id: high-level-viwi - url_fetch: "https://raw.githubusercontent.com/benierc/high-level-viwi-service/master/%source%" - path: docs/high-level-viwi-book.yml + id: app-framework-main-developer-guides + git_name: src/app-framework-main + path: docs/api-services-book.yml +- + id: app-framework-binder-developer-guides + git_name: src/app-framework-binder + path: docs/api-services-book.yml +- + id: app-afb-test-developer-guides + git_name: apps/app-afb-test + path: docs/api-services-book.yml + #- + # id: docs-sources-developer-guides + # url_fetch: GITHUB_FETCH + # git_name: automotive-grade-linux/docs-sources + # path: docs/api-services-book.yml + # books: + # - + # id: agl-service-can-low-level-developer-guides + # git_name: apps/agl-service-can-low-level + # path: docs/api-services-book.yml + # - + # id: high-level-developer-guides + # url_fetch: GITHUB_FETCH + # git_name: iotbzh/high-level-viwi-service + # path: docs/api-services-book.yml + # - + # id: agl-service-signal-composer-developer-guides + # git_name: apps/agl-service-signal-composer + # path: docs/api-services-book.yml + ##- 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 + # - + # id: iotbzh-agl-documentation-developer-guides + # url_fetch: GITHUB_FETCH + # git_name: iotbzh/agl-documentation + # path: api-services-book.yml + #- + # id: agl-service-audio-4a-developer-guides + # git_name: apps/agl-service-audio-4a + # path: docs/api-services-book.yml + # - + # id: docs-sources-audio-developer-guides + # url_fetch: GITHUB_FETCH + # git_name: automotive-grade-linux/docs-sources + # path: docs/audio-api-services-book.yml + #- + # id: pulseaudio-module-4a-developer-guides + # git_name: src/pulseaudio-module-4a + # path: api-services-book.yml + #- + # id: agl-service-homescreen-developer-guides + # git_name: apps/agl-service-homescreen + # path: doc/api-services-book.yml + #- + # id: agl-service-windowmanager-developer-guides + # git_name: apps/agl-service-windowmanager + # path: doc/api-services-book.yml + #- + # id: agl-service-soundmanager-developer-guides + # git_name: apps/agl-service-soundmanager + # path: doc/api-services-book.yml + #- + # id: homescreen-developer-guides + # git_name: apps/homescreen + # path: api-services-book.yml + # diff --git a/content/tocs/apis_services/toc_dev_en.yml b/content/tocs/apis_services/toc_dev_en.yml index 023e699..7737fcf 100644 --- a/content/tocs/apis_services/toc_dev_en.yml +++ b/content/tocs/apis_services/toc_dev_en.yml @@ -95,7 +95,7 @@ children: - url: reference/afb-test/binding-assert-functions.html - url: reference/afb-test/test-framework-functions.html - name: LuaUnit Assertion Functions - children: + children: - url: reference/afb-test/general-assertions.html - url: reference/afb-test/value-assertions.html - url: reference/afb-test/scientific-assertions.html diff --git a/content/tocs/getting_started/section_flounder.yml b/content/tocs/getting_started/section_flounder.yml deleted file mode 100644 index 35f39ea..0000000 --- a/content/tocs/getting_started/section_flounder.yml +++ /dev/null @@ -1,16 +0,0 @@ -url_fetch : "AGL_GITHUB_FETCH" -url_edit : "AGL_GITHUB_EDIT" -git_commit : "AGL_GITHUB_BRANCH" - -name: Getting started -template: generated_index.html -books: -- - id: docs-source-getting-started - git_name: "automotive-grade-linux/docs-sources" - git_commit: master-next - path: docs/getting-started-book.yml -- - id: homescreen - url_fetch : "https://git.automotivelinux.org/apps/homescreen/plain/homescreen/docs/homescreen-book.yml?h=sandbox/benierc/newdocs" - path: homescreen/docs/homescreen-book.yml diff --git a/content/tocs/getting_started/section_master.yml b/content/tocs/getting_started/section_master.yml deleted file mode 100644 index b6e663c..0000000 --- a/content/tocs/getting_started/section_master.yml +++ /dev/null @@ -1,16 +0,0 @@ -url_fetch : "AGL_GITHUB_FETCH" -url_edit : "AGL_GITHUB_EDIT" -git_commit : "AGL_GITHUB_BRANCH" - -name: Getting started -template: generated_index.html -books: -- - id: docs-source-getting-started - git_name: "automotive-grade-linux/docs-sources" - git_commit: AGL_GITHUB_BRANCH - path: docs/getting-started-book.yml -- - id: homescreen - url_fetch : "https://git.automotivelinux.org/apps/homescreen/plain/homescreen/docs/homescreen-book.yml?h=sandbox/benierc/newdocs" - path: homescreen/docs/homescreen-book.yml -- cgit From e08631ee7612e164474257485617361eddee3ed4 Mon Sep 17 00:00:00 2001 From: Sebastien Douheret Date: Fri, 21 Dec 2018 09:22:30 +0100 Subject: Add new section_master yaml files. Change-Id: I8e53a3cb7ca4d1b5b7749b0bf2fe8715a3f240b2 Signed-off-by: Sebastien Douheret --- content/tocs/architecture/section_master.yml | 21 +++++++++++++++++++++ content/tocs/getting_started/section_master.yml | 19 +++++++++++++++++++ content/tocs/hardware/section_master.yml | 11 +++++++++++ 3 files changed, 51 insertions(+) create mode 100644 content/tocs/architecture/section_master.yml create mode 100644 content/tocs/getting_started/section_master.yml create mode 100644 content/tocs/hardware/section_master.yml (limited to 'content/tocs') diff --git a/content/tocs/architecture/section_master.yml b/content/tocs/architecture/section_master.yml new file mode 100644 index 0000000..0ddfe15 --- /dev/null +++ b/content/tocs/architecture/section_master.yml @@ -0,0 +1,21 @@ +url_fetch : "GERRIT_FETCH" +# FIXME: restore line below to switch back on master: +#git_commit : "AGL_GERRIT_BRANCH" +git_commit : "sandbox/benierc/newdocs" + +name: Developer Guides +template: generated_index.html +books: +# FIXME: fix support of pdf source +# - +# id: agl_specifications +# url_fetch: AGL_GITHUB_FETCH +# git_name: automotive-grade-linux/docs-sources +# dst_prefix: AGL_Specifications +# path: docs/agl-specs-book.yml +- + id: security_blueprint + url_fetch: AGL_GITHUB_FETCH + git_name: automotive-grade-linux/docs-sources + dst_prefix: security + path: docs/security-blueprint-book.yml diff --git a/content/tocs/getting_started/section_master.yml b/content/tocs/getting_started/section_master.yml new file mode 100644 index 0000000..6089a08 --- /dev/null +++ b/content/tocs/getting_started/section_master.yml @@ -0,0 +1,19 @@ +url_fetch : "GERRIT_FETCH" +git_commit : "AGL_GERRIT_BRANCH" + +name: Getting started +template: generated_index.html +books: +- + id: image-development-workflow + url_fetch: AGL_GITHUB_FETCH + # FIXME: delete line below to switch back to AGL_GERRIT_BRANCH + git_commit: sandbox/benierc/newdocs + git_name: automotive-grade-linux/docs-sources + path: docs/getting-started-book.yml +- + id: apps-homescreen + url_fetch: GERRIT_FETCH + git_name: apps/homescreen + dst_prefix: homescreen + path: homescreen/docs/homescreen-book.yml diff --git a/content/tocs/hardware/section_master.yml b/content/tocs/hardware/section_master.yml new file mode 100644 index 0000000..e0b95d9 --- /dev/null +++ b/content/tocs/hardware/section_master.yml @@ -0,0 +1,11 @@ +url_fetch : "GERRIT_FETCH" +git_commit : "AGL_GERRIT_BRANCH" + +name: Hardware Support +template: generated_index.html +books: +- + id: renesas-gen3-boards + git_name: AGL/meta-renesas-rcar-gen3 + path: meta-rcar-gen3/docs-book.yml + dst_prefix: renesas-gen3 -- cgit From dcc03175f1c66fed1d057a9c33868956b4ca8f32 Mon Sep 17 00:00:00 2001 From: Frederic Marec Date: Fri, 21 Dec 2018 12:00:54 +0100 Subject: docs: Add new section_master yaml files Bug-AGL: SPEC-1988 Signed-off-by: Frederic Marec --- content/tocs/apis_services/section_master.yml | 122 ++++++++++++++------------ content/tocs/devguides/section_master.yml | 50 +++++++++++ 2 files changed, 115 insertions(+), 57 deletions(-) create mode 100644 content/tocs/devguides/section_master.yml (limited to 'content/tocs') diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml index 6bfaf6b..b981da1 100644 --- a/content/tocs/apis_services/section_master.yml +++ b/content/tocs/apis_services/section_master.yml @@ -1,7 +1,7 @@ url_fetch : "GERRIT_FETCH" git_commit : "AGL_GERRIT_BRANCH" -name: Developer Guides +name: APIs & Services template: generated_index.html books: - @@ -13,64 +13,72 @@ books: git_name: src/app-framework-binder path: docs/api-services-book.yml - - id: app-afb-test-developer-guides - git_name: apps/app-afb-test + id: agl-service-can-low-level-developer-guides + git_name: apps/agl-service-can-low-level path: docs/api-services-book.yml - #- - # id: docs-sources-developer-guides - # url_fetch: GITHUB_FETCH - # git_name: automotive-grade-linux/docs-sources - # path: docs/api-services-book.yml - # books: - # - - # id: agl-service-can-low-level-developer-guides - # git_name: apps/agl-service-can-low-level - # path: docs/api-services-book.yml - # - - # id: high-level-developer-guides - # url_fetch: GITHUB_FETCH - # git_name: iotbzh/high-level-viwi-service - # path: docs/api-services-book.yml - # - - # id: agl-service-signal-composer-developer-guides - # git_name: apps/agl-service-signal-composer - # path: docs/api-services-book.yml +#- +# id: app-afb-test-developer-guides +# git_name: apps/app-afb-test +# path: docs/api-services-book.yml +- + id: high-level-developer-guides + url_fetch: GITHUB_FETCH + git_name: iotbzh/high-level-viwi-service + path: docs/api-services-book.yml +- + id: agl-service-signal-composer-developer-guides + git_name: apps/agl-service-signal-composer + path: docs/api-services-book.yml +- + id: candevstudio-developer-guides + url_fetch: GITHUB_FETCH + git_name: iotbzh/agl-documentation + path: candevstudio/docs/api-services-book.yml +- + id: app-framework-developer-guides + url_fetch: GITHUB_FETCH + git_name: automotive-grade-linux/docs-sources + git_commit: sandbox/benierc/newdocs + path: docs/app-framework-book.yml +- + id: signaling-developer-guides + url_fetch: GITHUB_FETCH + git_name: automotive-grade-linux/docs-sources + git_commit: sandbox/benierc/newdocs + path: docs/signaling-book.yml + ##- 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 - # - - # id: iotbzh-agl-documentation-developer-guides - # url_fetch: GITHUB_FETCH - # git_name: iotbzh/agl-documentation - # path: api-services-book.yml - #- - # id: agl-service-audio-4a-developer-guides - # git_name: apps/agl-service-audio-4a - # path: docs/api-services-book.yml - # - - # id: docs-sources-audio-developer-guides - # url_fetch: GITHUB_FETCH - # git_name: automotive-grade-linux/docs-sources - # path: docs/audio-api-services-book.yml - #- - # id: pulseaudio-module-4a-developer-guides - # git_name: src/pulseaudio-module-4a - # path: api-services-book.yml - #- - # id: agl-service-homescreen-developer-guides - # git_name: apps/agl-service-homescreen - # path: doc/api-services-book.yml - #- - # id: agl-service-windowmanager-developer-guides - # git_name: apps/agl-service-windowmanager - # path: doc/api-services-book.yml - #- - # id: agl-service-soundmanager-developer-guides - # git_name: apps/agl-service-soundmanager - # path: doc/api-services-book.yml - #- - # id: homescreen-developer-guides - # git_name: apps/homescreen - # path: api-services-book.yml - # +- + id: audio-developer-guides + url_fetch: GITHUB_FETCH + git_name: automotive-grade-linux/docs-sources + git_commit: sandbox/benierc/newdocs + path: docs/audio-book.yml +- + id: agl-service-audio-4a-developer-guides + git_name: apps/agl-service-audio-4a + path: docs/api-services-book.yml +- + id: pulseaudio-module-4a-developer-guides + git_name: src/pulseaudio-module-4a + path: api-services-book.yml +- + id: agl-service-homescreen-developer-guides + git_name: apps/agl-service-homescreen + path: doc/api-services-book.yml +- + id: agl-service-windowmanager-developer-guides + git_name: apps/agl-service-windowmanager + path: doc/api-services-book.yml +- + id: agl-service-soundmanager-developer-guides + git_name: apps/agl-service-soundmanager + path: doc/api-services-book.yml +- + id: homescreen-developer-guides + git_name: apps/homescreen + path: homescreen/docs/api-services-book.yml + diff --git a/content/tocs/devguides/section_master.yml b/content/tocs/devguides/section_master.yml new file mode 100644 index 0000000..0ef7d59 --- /dev/null +++ b/content/tocs/devguides/section_master.yml @@ -0,0 +1,50 @@ +url_fetch : "GERRIT_FETCH" +git_commit : "AGL_GERRIT_BRANCH" + +name: Developers Guides +template: generated_index.html +books: +- + id: meta-agl-developer-guides + git_name: AGL/meta-agl + path: docs/devguides-book.yml +- + 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 +#- +# url_fetch: https://iot.bzh/download/public/2016/%source% +# dst_prefix: iotbzh2016 +# documents: +# - source: appfw/03-AGL-AppFW-Privileges-Management.pdf +- + id: host-configuration-developer-guides + url_fetch: GITHUB_FETCH + 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 +- + id: xds-docs-guides + git_name: src/xds/xds-docs + path: docs/devguides-book.yml +#- +# 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 +- + id: app-controller-submodule-guides + git_name: apps/app-controller-submodule + path: docs/devguides-book.yml + + -- cgit From 783a8763bdf440818d4ba61d4b1b511d317cb90f Mon Sep 17 00:00:00 2001 From: Sebastien Douheret Date: Sat, 22 Dec 2018 21:24:36 +0100 Subject: Add missing url_edit and dst_prefix fields Change-Id: I98e44f3b7abe9403d0a1f2eeaa1cec1ef1ff30e1 Signed-off-by: Sebastien Douheret --- content/tocs/apis_services/section_master.yml | 35 ++++++++++++++++++++----- content/tocs/architecture/section_master.yml | 1 + content/tocs/devguides/section_master.yml | 4 +++ content/tocs/getting_started/section_master.yml | 1 + 4 files changed, 35 insertions(+), 6 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml index b981da1..ae56813 100644 --- a/content/tocs/apis_services/section_master.yml +++ b/content/tocs/apis_services/section_master.yml @@ -8,23 +8,30 @@ books: id: app-framework-main-developer-guides git_name: src/app-framework-main path: docs/api-services-book.yml + dst_prefix: af-main - id: app-framework-binder-developer-guides git_name: src/app-framework-binder path: docs/api-services-book.yml + dst_prefix: af-binder - id: agl-service-can-low-level-developer-guides git_name: apps/agl-service-can-low-level path: docs/api-services-book.yml + dst_prefix: signaling +# FIXME #- # id: app-afb-test-developer-guides # git_name: apps/app-afb-test # path: docs/api-services-book.yml +# dst_prefix: afb-test - id: high-level-developer-guides url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT git_name: iotbzh/high-level-viwi-service path: docs/api-services-book.yml + dst_prefix: signaling - id: agl-service-signal-composer-developer-guides git_name: apps/agl-service-signal-composer @@ -32,53 +39,69 @@ books: - id: candevstudio-developer-guides url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT git_name: iotbzh/agl-documentation path: candevstudio/docs/api-services-book.yml + dst_prefix: candevstudio - id: app-framework-developer-guides url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT git_name: automotive-grade-linux/docs-sources git_commit: sandbox/benierc/newdocs path: docs/app-framework-book.yml + dst_prefix: af-binder - id: signaling-developer-guides url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT git_name: automotive-grade-linux/docs-sources git_commit: sandbox/benierc/newdocs path: docs/signaling-book.yml - - ##- 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 + src_prefix: docs/signaling +# FIXME +# - +# id: devel-guidelines-2016 +# url_fetch: https://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 - id: audio-developer-guides url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT git_name: automotive-grade-linux/docs-sources git_commit: sandbox/benierc/newdocs path: docs/audio-book.yml + dst_prefix: audio - id: agl-service-audio-4a-developer-guides git_name: apps/agl-service-audio-4a path: docs/api-services-book.yml + dst_prefix: audio - id: pulseaudio-module-4a-developer-guides git_name: src/pulseaudio-module-4a path: api-services-book.yml + dst_prefix: audio - id: agl-service-homescreen-developer-guides git_name: apps/agl-service-homescreen path: doc/api-services-book.yml + dst_prefix: hmi-framework - id: agl-service-windowmanager-developer-guides git_name: apps/agl-service-windowmanager path: doc/api-services-book.yml + dst_prefix: hmi-framework - id: agl-service-soundmanager-developer-guides git_name: apps/agl-service-soundmanager path: doc/api-services-book.yml + dst_prefix: hmi-framework - id: homescreen-developer-guides git_name: apps/homescreen path: homescreen/docs/api-services-book.yml - + dst_prefix: hmi-framework diff --git a/content/tocs/architecture/section_master.yml b/content/tocs/architecture/section_master.yml index 0ddfe15..7764a1c 100644 --- a/content/tocs/architecture/section_master.yml +++ b/content/tocs/architecture/section_master.yml @@ -16,6 +16,7 @@ books: - id: security_blueprint url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT git_name: automotive-grade-linux/docs-sources dst_prefix: security path: docs/security-blueprint-book.yml diff --git a/content/tocs/devguides/section_master.yml b/content/tocs/devguides/section_master.yml index 0ef7d59..f3bc7ec 100644 --- a/content/tocs/devguides/section_master.yml +++ b/content/tocs/devguides/section_master.yml @@ -24,16 +24,19 @@ books: - 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" #- # url_fetch: GITHUB_FETCH # url_edit: GITHUB_EDIT @@ -46,5 +49,6 @@ books: id: app-controller-submodule-guides git_name: apps/app-controller-submodule path: docs/devguides-book.yml + dst_prefix: ctrler diff --git a/content/tocs/getting_started/section_master.yml b/content/tocs/getting_started/section_master.yml index 6089a08..418c3b0 100644 --- a/content/tocs/getting_started/section_master.yml +++ b/content/tocs/getting_started/section_master.yml @@ -7,6 +7,7 @@ books: - id: image-development-workflow url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT # FIXME: delete line below to switch back to AGL_GERRIT_BRANCH git_commit: sandbox/benierc/newdocs git_name: automotive-grade-linux/docs-sources -- cgit From c62f3d3b8a7d996bec5ce181a5b245d792796cc2 Mon Sep 17 00:00:00 2001 From: Sebastien Douheret Date: Sat, 22 Dec 2018 21:26:36 +0100 Subject: Remove fetched and toc yaml files (old method) Change-Id: I515d45f197a815bb2b169ba0380ef0e8b7fbc4f8 Signed-off-by: Sebastien Douheret --- content/tocs/apis_services/fetched_files.yml | 420 ------------------------- content/tocs/apis_services/toc_dev_en.yml | 181 ----------- content/tocs/architecture/fetched_files.yml | 140 --------- content/tocs/architecture/toc_dev_en.yml | 106 ------- content/tocs/devguides/fetched_files.yml | 216 ------------- content/tocs/devguides/toc_dev_en.yml | 291 ----------------- content/tocs/getting_started/fetched_files.yml | 122 ------- content/tocs/getting_started/toc_dev_en.yml | 83 ----- content/tocs/hardware/fetched_files.yml | 56 ---- content/tocs/hardware/toc_dev_en.yml | 45 --- 10 files changed, 1660 deletions(-) delete mode 100644 content/tocs/apis_services/fetched_files.yml delete mode 100644 content/tocs/apis_services/toc_dev_en.yml delete mode 100644 content/tocs/architecture/fetched_files.yml delete mode 100644 content/tocs/architecture/toc_dev_en.yml delete mode 100644 content/tocs/devguides/fetched_files.yml delete mode 100644 content/tocs/devguides/toc_dev_en.yml delete mode 100644 content/tocs/getting_started/fetched_files.yml delete mode 100644 content/tocs/getting_started/toc_dev_en.yml delete mode 100644 content/tocs/hardware/fetched_files.yml delete mode 100644 content/tocs/hardware/toc_dev_en.yml (limited to 'content/tocs') diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml deleted file mode 100644 index f1709a0..0000000 --- a/content/tocs/apis_services/fetched_files.yml +++ /dev/null @@ -1,420 +0,0 @@ -############################################################################################################## -# GLOBAL DOCUMENT -# : 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 - src_prefix: docs - dst_prefix: af-main - documents: - - source: 0-introduction.md - label: Introduction - - source: 0-kristi-introduction.md - label: API Reference - - 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 - src_prefix: docs - dst_prefix: af-binder - documents: - - source: index.md - label: Binder index - - source: afb-overview.md - label: Overview - - source: afb-binding-writing.md - label: How to write a binding ? - - source: afb-binding-references.md - label: Binding references - - source: reference-v3/types-and-globals.md - label: Types and globals - - source: reference-v3/func-api.md - label: Functions of class afb_api - - source: reference-v3/func-req.md - label: Functions of class afb_req - - source: reference-v3/func-event.md - label: Functions of class afb_event - - source: reference-v3/func-daemon.md - label: Functions of class afb_daemon - - source: reference-v3/func-service.md - label: Functions of class afb_service - - source: reference-v3/macro-log.md - label: Macros for logging - - source: afb-migration-to-binding-v3.md - label: Migration to bindings v3 - - 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-debugging.md - label: Debugging binder and bindings - - source: afb-daemon-options.md - label: Options of afb-daemon - - source: protocol-x-afb-ws-json1.md - label: WebSocket protocol x-afb-ws-json1 - - source: annexes.md - label: Annexes - - source: REVISIONS.md - label: Document revision - - source: legacy/afb-migration-v1-to-v2.md - label: LEGACY Migration from v1 to v2 - - source: legacy/afb-binding-v2-references.md - label: LEGACY Binding V2 references - - 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 - -- - git_name: apps/agl-service-can-low-level - 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 - -- - git_name: apps/app-afb-test - src_prefix: docs - dst_prefix: afb-test - documents: - - source: 0_Installation.md - destination: Installation.md - label: Installation - - source: 1_Write_the_tests.md - destination: write-the-tests.md - label: Write the tests - - source: 2_The_test_widget.md - destination: the-test-widget.md - label: The test widget - - source: 3_Launch_the_tests.md - destination: launch-the-tests.md - label: Launch the tests - - source: 4_Tests_Examples.md - destination: tests-examples.md - label: Tests examples - - source: Reference/0_BindingTestFunctions.md - destination: binding-test-functions.md - label: Binding Test Functions - - source: Reference/1_BindingAssertFunctions.md - destination: binding-assert-functions.md - label: Binding Assert Functions - - source: Reference/2_TestFrameworkFunctions.md - destination: test-framework-functions.md - label: Test Framework Functions - - source: Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md - destination: general-assertions.md - label: General Assertions - - source: Reference/LuaUnitAssertionFunctions/1_ValueAssertions.md - destination: value-assertions.md - label: Value Assertions - - source: Reference/LuaUnitAssertionFunctions/2_ScientificAssertions.md - destination: scientific-assertions.md - label: Scientific Assertions - - source: Reference/LuaUnitAssertionFunctions/3_StringAssertions.md - destination: string-assertions.md - label: String Assertions - - source: Reference/LuaUnitAssertionFunctions/4_ErrorAssertions.md - destination: error-assertions.md - label: Error Assertions - - source: Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md - destination: type-assertions.md - label: Type Assertions - - source: Reference/LuaUnitAssertionFunctions/6_TableAssertions.md - destination: table-assertions.md - label: Table Assertions - -- - url_fetch: GITHUB_FETCH - url_edit: GITHUB_EDIT - 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 -- - git_name: apps/agl-service-signal-composer - src_prefix: docs/part-1/ - dst_prefix: signaling - documents: - - source: 1-Architecture.md - destination: signal-composer-architecture.md - label: Architecture presentation - - source: 2-Configuration.md - destination: signal-composer-configuration.md - label: Configuration - - source: 3-Plugins.md - destination: signal-composer-plugins.md - label: Plugins - - source: 4-SignalComposerAPI.md - destination: signal-composer-api.md - label: Signal Composer API - - source: pictures/Global_Signaling_Architecture.png - - source: pictures/iotbzh_logo_small.png -- - url_fetch: GITHUB_FETCH - url_edit: GITHUB_EDIT - git_name: iotbzh/agl-documentation - git_commit: master - documents: - - source: candevstudio/docs/1_Usage.md - - source: candevstudio/docs/2_can_device_socketcan_backend.md - - source: candevstudio/docs/3_Add_CAN_Device.md - - source: candevstudio/docs/4_Configure_CanRawSender_Node.md - - source: candevstudio/docs/5_Using_CanRawView.md - - source: candevstudio/docs/pictures/CANdevStudio.png - - source: candevstudio/docs/pictures/canrawsender.png - - source: candevstudio/docs/pictures/canrawviewer.png - -- - 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/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: automotive-grade-linux/docs-sources - git_commit: AGL_GITHUB_BRANCH - src_prefix: docs/signaling - dst_prefix: signaling - documents: - - source: architecture.md - destination: architecture.md - label: Signaling Architecture - - 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 -- - url_fetch: https://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: automotive-grade-linux/docs-sources - git_commit: AGL_GITHUB_BRANCH - src_prefix: docs/audio - dst_prefix: audio - documents: - - source: 4a-framework.md - destination: 4a-framework.md - label: 4a-framework - - source: bluez-alsa.md - destination: bluez-alsa.md - label: bluez-alsa -- - git_name: apps/agl-service-audio-4a - src_prefix: docs - dst_prefix: audio - documents: - - source: 4a-framework/README.md - label: Architecture - - source: 4a-framework/concepts.md - label: Concepts - - source: 4a-framework/components.md - label: Components - - source: 4a-framework/images/4a-architecture.svg - - source: 4a-framework/images/apps-architecture.svg - - source: 4a-framework/images/agl-audio-arch.png - - source: high-level-api/README.md - label: Abstract - - source: high-level-api/kickstart.md - label: Kickstart - - source: high-level-api/reference.md - label: Reference - - source: high-level-api/TipsAndTricks/AdjustVolumes.md - label: Adjust volumes - - source: high-level-api/TipsAndTricks/4aTools.md - label: 4a-tools - - source: high-level-api/TipsAndTricks/Devices.md - label: Devices - - source: high-level-api/TipsAndTricks/HALs.md - label: HALs - - source: high-level-api/TipsAndTricks/images/changeSound.png - - source: high-level-api/TipsAndTricks/images/MixerBaseMenu.png -- - git_name: src/pulseaudio-module-4a - dst_prefix: audio - documents: - - source: README.md - destination: pulseaudio-module-4a.md - label: Pulseaudio - 4A Integration Module -- - git_name: apps/agl-service-homescreen - src_prefix: doc/ - dst_prefix: hmi-framework/ - documents: - - source: ApplicationGuide.md - destination: 3_1-HomeScreen-Guide.md - label: Home Screen Developper Guide - - source: parts/software-stack.png - - source: parts/initialize-set-event-handler.svg - - source: parts/tap_shortcut.svg - - source: parts/showWindow.svg - - source: parts/on_screen_message.svg - - source: parts/showOnScreen.svg - - source: parts/showNotification.svg - - source: parts/showInformation.svg -- - git_name: apps/agl-service-windowmanager - src_prefix: doc/ - dst_prefix: hmi-framework/ - documents: - - source: ApplicationGuide.md - destination: 3_2-WindowManager-Guide.md - label: Window Manager Developper Guide - - source: parts/state_change_example.png - - source: parts/wm_software_stack.png - - source: parts/wm_layer_stack.png - - source: parts/wm_area.png - - source: parts/request_role.png - - source: parts/hmi_framework_designed_seq_toyota.png - - source: parts/deactivate_window.png - - source: parts/example_split.png -- - git_name: apps/agl-service-soundmanager - 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 -- - 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 deleted file mode 100644 index 7737fcf..0000000 --- a/content/tocs/apis_services/toc_dev_en.yml +++ /dev/null @@ -1,181 +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: : 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/architecture/toc_dev_en.yml b/content/tocs/architecture/toc_dev_en.yml deleted file mode 100644 index 25c6f36..0000000 --- a/content/tocs/architecture/toc_dev_en.yml +++ /dev/null @@ -1,106 +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: : 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 - url_edit: GITHUB_EDIT - 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 -- - url_fetch: GITHUB_FETCH - url_edit: GITHUB_EDIT - 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_4-Inside-the-container.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-template.md - - source: sdk-devkit/docs/part-2/2_3-Dev-with-container.md - - 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 -- - 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: apps/app-controller-submodule - 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 diff --git a/content/tocs/devguides/toc_dev_en.yml b/content/tocs/devguides/toc_dev_en.yml deleted file mode 100644 index 86a436a..0000000 --- a/content/tocs/devguides/toc_dev_en.yml +++ /dev/null @@ -1,291 +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: : 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 -# ------------------------------------ -############################################################################################################## - -#dst_prefix: # destination_path = destination_prefix + (document.destination || document.source) - -url_fetch: GERRIT_FETCH -git_commit: AGL_GERRIT_BRANCH - -repositories: -- - 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/getting-started - documents : - - source: app-workflow-intro.md - label: Overview - - source: app-workflow-image.md - label: Download or Build Your Image - - source: app-workflow-sdk.md - label: Download or Build Your SDK Installer - - source: app-workflow-bootables.md - label: Create Bootable Media - - source: app-workflow-boot.md - label: Boot the Image on the Board - - source: app-workflow-prep-app.md - label: Get Ready to Create Your Application - - source: app-workflow-build-app.md - label: Create and Build the Application - - source: app-workflow-deploy-app.md - label: Deploy the Application to the Board - - source: app-workflow-debug-app.md - label: Debug the Application - - source: images/app-developer-workflow.png - destination: images/app-developer-workflow.png - - source: image-workflow-intro.md - label: Overview - - source: image-workflow-prep-host.md - label: Preparing Your Build Host - - source: image-workflow-download-sw.md - label: Downloading AGL Software - - source: image-workflow-initialize-build-environment.md - label: Initializing Your Build Environment - - source: image-workflow-cust-build.md - label: Customizing Your Build - - source: image-workflow-build.md - label: Building the AGL Image - - source: machines/intel.md - label: Building for Most Intel 64-Bit Hardware Platforms - - source: machines/qemu.md - label: Building for Emulation - - source: machines/renesas.md - label: Building for Supported Renesas Boards - - source: machines/raspberrypi.md - label: Building for Raspberry PI 2 or 3 - - source: images/image-developer-workflow.png - destination: images/image-developer-workflow.png - - source: troubleshooting.md - label: Generic issues - - source: footers/intel-footer.md - label: Intel Boards - - source: footers/raspberrypi-footer.md - label: Raspberry PI - - source: footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpg - destination: footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpg - - source: docker-container-setup.md - label: Setting Up a Docker Container -- - git_name: apps/homescreen - 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 deleted file mode 100644 index 6bb5dcc..0000000 --- a/content/tocs/getting_started/toc_dev_en.yml +++ /dev/null @@ -1,83 +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: : 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 -# ------------------------------------ -############################################################################################################## - -#dst_prefix: # destination_path = destination_prefix + (document.destination || document.source) - -url_fetch: "GERRIT_FETCH" -git_commit: "AGL_GERRIT_BRANCH" - -repositories: -- - git_name: AGL/meta-renesas-rcar-gen3 - dst_prefix: renesas-gen3 - documents: - - source: meta-rcar-gen3/README - destination: gen3.md - label: meta-rcar-gen3 layer - - source: meta-rcar-gen3/README.proprietary - destination: proprietary.md - label: Proprietary drivers - diff --git a/content/tocs/hardware/toc_dev_en.yml b/content/tocs/hardware/toc_dev_en.yml deleted file mode 100644 index 6c49ed8..0000000 --- a/content/tocs/hardware/toc_dev_en.yml +++ /dev/null @@ -1,45 +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: Date: Wed, 9 Jan 2019 14:49:38 +0100 Subject: Add yaml files for flounder version Add yaml files for flounder version documentation Uncomment app-afb-test part for apis_services section Add node_modules & package.json in .gitignore Signed-off-by: Frederic Marec --- content/tocs/apis_services/section_flounder.yml | 108 ++++++++++++++++++++++ content/tocs/apis_services/section_master.yml | 11 +-- content/tocs/architecture/section_flounder.yml | 22 +++++ content/tocs/devguides/section_flounder.yml | 55 +++++++++++ content/tocs/getting_started/section_flounder.yml | 20 ++++ content/tocs/hardware/section_flounder.yml | 11 +++ 6 files changed, 221 insertions(+), 6 deletions(-) create mode 100644 content/tocs/apis_services/section_flounder.yml create mode 100644 content/tocs/architecture/section_flounder.yml create mode 100644 content/tocs/devguides/section_flounder.yml create mode 100644 content/tocs/getting_started/section_flounder.yml create mode 100644 content/tocs/hardware/section_flounder.yml (limited to 'content/tocs') diff --git a/content/tocs/apis_services/section_flounder.yml b/content/tocs/apis_services/section_flounder.yml new file mode 100644 index 0000000..ceb1912 --- /dev/null +++ b/content/tocs/apis_services/section_flounder.yml @@ -0,0 +1,108 @@ +url_fetch : "GERRIT_FETCH" +git_commit : "flounder" + +name: APIs & Services +template: generated_index.html +books: +- + id: app-framework-main-developer-guides-flounder + git_name: src/app-framework-main + path: docs/api-services-book.yml + dst_prefix: af-main +- + id: app-framework-binder-developer-guides-flounder + git_name: src/app-framework-binder + path: docs/api-services-book.yml + dst_prefix: af-binder +- + id: agl-service-can-low-level-developer-guides-flounder + git_name: apps/agl-service-can-low-level + path: docs/api-services-book.yml + dst_prefix: signaling +- + id: app-afb-test-developer-guides-flounder + git_name: apps/app-afb-test + path: docs/api-services-book.yml + dst_prefix: afb-test +- + id: high-level-developer-guides-flounder + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: iotbzh/high-level-viwi-service + git_commit: master + path: docs/api-services-book.yml + dst_prefix: signaling +- + id: agl-service-signal-composer-developer-guides-flounder + git_name: apps/agl-service-signal-composer + path: docs/api-services-book.yml +- + id: candevstudio-developer-guides-flounder + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: iotbzh/agl-documentation + git_commit: master + path: candevstudio/docs/api-services-book.yml + dst_prefix: candevstudio +- + id: app-framework-developer-guides-flounder + url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + git_commit: sandbox/benierc/newdocs + path: docs/app-framework-book.yml + dst_prefix: af-binder +- + id: signaling-developer-guides-flounder + url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + git_commit: sandbox/benierc/newdocs + path: docs/signaling-book.yml + src_prefix: docs/signaling +# FIXME +# - +# id: devel-guidelines-2016-flounder +# url_fetch: https://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 +- + id: audio-developer-guides-flounder + url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + git_commit: sandbox/benierc/newdocs + path: docs/audio-book.yml + dst_prefix: audio +- + id: agl-service-audio-4a-developer-guides-flounder + git_name: apps/agl-service-audio-4a + path: docs/api-services-book.yml + dst_prefix: audio +- + id: pulseaudio-module-4a-developer-guides-flounder + git_name: src/pulseaudio-module-4a + path: api-services-book.yml + dst_prefix: audio +- + id: agl-service-homescreen-developer-guides-flounder + git_name: apps/agl-service-homescreen + path: doc/api-services-book.yml + dst_prefix: hmi-framework +- + id: agl-service-windowmanager-developer-guides-flounder + git_name: apps/agl-service-windowmanager + path: doc/api-services-book.yml + dst_prefix: hmi-framework +- + id: agl-service-soundmanager-developer-guides-flounder + git_name: apps/agl-service-soundmanager + path: doc/api-services-book.yml + dst_prefix: hmi-framework +- + id: homescreen-developer-guides-flounder + git_name: apps/homescreen + path: homescreen/docs/api-services-book.yml + dst_prefix: hmi-framework diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml index ae56813..d2e3813 100644 --- a/content/tocs/apis_services/section_master.yml +++ b/content/tocs/apis_services/section_master.yml @@ -19,12 +19,11 @@ books: git_name: apps/agl-service-can-low-level path: docs/api-services-book.yml dst_prefix: signaling -# FIXME -#- -# id: app-afb-test-developer-guides -# git_name: apps/app-afb-test -# path: docs/api-services-book.yml -# dst_prefix: afb-test +- + id: app-afb-test-developer-guides + git_name: apps/app-afb-test + path: docs/api-services-book.yml + dst_prefix: afb-test - id: high-level-developer-guides url_fetch: GITHUB_FETCH diff --git a/content/tocs/architecture/section_flounder.yml b/content/tocs/architecture/section_flounder.yml new file mode 100644 index 0000000..20aa1d6 --- /dev/null +++ b/content/tocs/architecture/section_flounder.yml @@ -0,0 +1,22 @@ +url_fetch : "GERRIT_FETCH" +# FIXME: restore line below to switch back on master: +#git_commit : "AGL_GERRIT_BRANCH" +git_commit : "sandbox/benierc/newdocs" + +name: Developer Guides +template: generated_index.html +books: +# FIXME: fix support of pdf source +# - +# id: agl_specifications-flounder +# url_fetch: AGL_GITHUB_FETCH +# git_name: automotive-grade-linux/docs-sources +# dst_prefix: AGL_Specifications +# path: docs/agl-specs-book.yml +- + id: security_blueprint-flounder + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + dst_prefix: security + path: docs/security-blueprint-book.yml diff --git a/content/tocs/devguides/section_flounder.yml b/content/tocs/devguides/section_flounder.yml new file mode 100644 index 0000000..0fbb492 --- /dev/null +++ b/content/tocs/devguides/section_flounder.yml @@ -0,0 +1,55 @@ +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 +- + 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 +#- +# url_fetch: https://iot.bzh/download/public/2016/%source% +# dst_prefix: iotbzh2016 +# documents: +# - source: appfw/03-AGL-AppFW-Privileges-Management.pdf +- + 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" +#- +# 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 +- + id: app-controller-submodule-guides-flounder + git_name: apps/app-controller-submodule + path: docs/devguides-book.yml + dst_prefix: ctrler + + diff --git a/content/tocs/getting_started/section_flounder.yml b/content/tocs/getting_started/section_flounder.yml new file mode 100644 index 0000000..3e05b78 --- /dev/null +++ b/content/tocs/getting_started/section_flounder.yml @@ -0,0 +1,20 @@ +url_fetch : "GERRIT_FETCH" +git_commit : "flounder" + +name: Getting started +template: generated_index.html +books: +- + id: image-development-workflow-flounder + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + # FIXME: delete line below to switch back to AGL_GERRIT_BRANCH + git_commit: sandbox/benierc/newdocs + git_name: automotive-grade-linux/docs-sources + path: docs/getting-started-book.yml +- + id: apps-homescreen-flounder + url_fetch: GERRIT_FETCH + git_name: apps/homescreen + dst_prefix: homescreen + path: homescreen/docs/homescreen-book.yml diff --git a/content/tocs/hardware/section_flounder.yml b/content/tocs/hardware/section_flounder.yml new file mode 100644 index 0000000..fd6388b --- /dev/null +++ b/content/tocs/hardware/section_flounder.yml @@ -0,0 +1,11 @@ +url_fetch : "GERRIT_FETCH" +git_commit : "flounder" + +name: Hardware Support +template: generated_index.html +books: +- + id: renesas-gen3-boards-flounder + git_name: AGL/meta-renesas-rcar-gen3 + path: meta-rcar-gen3/docs-book.yml + dst_prefix: renesas-gen3 -- cgit From 610dfcdc46963cdf91a6413126dd82a7071cd220 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Wed, 13 Feb 2019 17:38:56 +0100 Subject: apis_service/section_master: fix errors MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/apis_services/section_master.yml | 133 +++++++++++++------------- 1 file changed, 67 insertions(+), 66 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml index d2e3813..10cb3f6 100644 --- a/content/tocs/apis_services/section_master.yml +++ b/content/tocs/apis_services/section_master.yml @@ -14,91 +14,92 @@ books: git_name: src/app-framework-binder path: docs/api-services-book.yml dst_prefix: af-binder -- - id: agl-service-can-low-level-developer-guides - git_name: apps/agl-service-can-low-level - path: docs/api-services-book.yml - dst_prefix: signaling - id: app-afb-test-developer-guides git_name: apps/app-afb-test path: docs/api-services-book.yml dst_prefix: afb-test - - id: high-level-developer-guides + id: docs-source-signaling url_fetch: GITHUB_FETCH url_edit: GITHUB_EDIT - git_name: iotbzh/high-level-viwi-service - path: docs/api-services-book.yml + git_name: docs-source + path: docs/signaling-book.yml dst_prefix: signaling + books: + - id: agl-service-can-low-level-developer-guides + git_name: apps/agl-service-can-low-level + path: docs/api-services-book.yml + dst_prefix: signaling + - id: high-level-developer-guides + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: iotbzh/high-level-viwi-service + path: docs/api-services-book.yml + dst_prefix: signaling + - id: agl-service-signal-composer-developer-guides + git_name: apps/agl-service-signal-composer + path: docs/api-services-book.yml + - id: devel-appfw-guidelines-2016 + path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf + dst_prefix: iotbzh2016 + name: Developer Guidelines + - id: devel-message-guidelines-2016 + path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf + dst_prefix: iotbzh2016 + name: CAN Signaling Benchmark + - id: candevstudio-developer-guides + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: iotbzh/agl-documentation + path: candevstudio/docs/api-services-book.yml + dst_prefix: candevstudio + - id: app-framework-developer-guides + url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + git_commit: sandbox/benierc/newdocs + path: docs/app-framework-book.yml + dst_prefix: af-binder - - id: agl-service-signal-composer-developer-guides - git_name: apps/agl-service-signal-composer - path: docs/api-services-book.yml -- - id: candevstudio-developer-guides - url_fetch: GITHUB_FETCH - url_edit: GITHUB_EDIT - git_name: iotbzh/agl-documentation - path: candevstudio/docs/api-services-book.yml - dst_prefix: candevstudio -- - id: app-framework-developer-guides - url_fetch: GITHUB_FETCH - url_edit: AGL_GITHUB_EDIT - git_name: automotive-grade-linux/docs-sources - git_commit: sandbox/benierc/newdocs - path: docs/app-framework-book.yml - dst_prefix: af-binder -- - id: signaling-developer-guides + id: audio-developer-guides url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT git_name: automotive-grade-linux/docs-sources git_commit: sandbox/benierc/newdocs - path: docs/signaling-book.yml - src_prefix: docs/signaling -# FIXME -# - -# id: devel-guidelines-2016 -# url_fetch: https://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 -- - id: audio-developer-guides + path: docs/audio-book.yml + dst_prefix: audio + books: + - id: pulseaudio-module-4a-developer-guides + git_name: src/pulseaudio-module-4a + path: api-services-book.yml + dst_prefix: audio + - id: agl-service-audio-4a-developer-guides + git_name: apps/agl-service-audio-4a + path: docs/api-services-book.yml + dst_prefix: audio +- + id: hmi-framework url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT git_name: automotive-grade-linux/docs-sources git_commit: sandbox/benierc/newdocs - path: docs/audio-book.yml - dst_prefix: audio -- - id: agl-service-audio-4a-developer-guides - git_name: apps/agl-service-audio-4a - path: docs/api-services-book.yml - dst_prefix: audio -- - id: pulseaudio-module-4a-developer-guides - git_name: src/pulseaudio-module-4a - path: api-services-book.yml - dst_prefix: audio -- - id: agl-service-homescreen-developer-guides - git_name: apps/agl-service-homescreen - path: doc/api-services-book.yml - dst_prefix: hmi-framework -- - id: agl-service-windowmanager-developer-guides - git_name: apps/agl-service-windowmanager - path: doc/api-services-book.yml - dst_prefix: hmi-framework -- - id: agl-service-soundmanager-developer-guides - git_name: apps/agl-service-soundmanager - path: doc/api-services-book.yml + path: docs/hmi-framework-book.yml dst_prefix: hmi-framework + books: + - id: agl-service-homescreen-developer-guides + name: HMI Framework + git_name: apps/agl-service-homescreen + path: doc/api-services-book.yml + dst_prefix: hmi-framework + - id: agl-service-windowmanager-developer-guides + git_name: apps/agl-service-windowmanager + path: doc/api-services-book.yml + dst_prefix: hmi-framework + - id: agl-service-soundmanager-developer-guides + git_name: apps/agl-service-soundmanager + path: doc/api-services-book.yml + dst_prefix: hmi-framework - id: homescreen-developer-guides git_name: apps/homescreen -- cgit From a71578904d396e8fd6319703b93ed33d1a29239d Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Sun, 24 Feb 2019 14:42:09 +0100 Subject: section_master: switch to master MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/apis_services/section_master.yml | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml index 10cb3f6..e137e21 100644 --- a/content/tocs/apis_services/section_master.yml +++ b/content/tocs/apis_services/section_master.yml @@ -1,5 +1,4 @@ url_fetch : "GERRIT_FETCH" -git_commit : "AGL_GERRIT_BRANCH" name: APIs & Services template: generated_index.html @@ -21,9 +20,9 @@ books: dst_prefix: afb-test - id: docs-source-signaling - url_fetch: GITHUB_FETCH - url_edit: GITHUB_EDIT - git_name: docs-source + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources path: docs/signaling-book.yml dst_prefix: signaling books: @@ -58,7 +57,6 @@ books: url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT git_name: automotive-grade-linux/docs-sources - git_commit: sandbox/benierc/newdocs path: docs/app-framework-book.yml dst_prefix: af-binder - @@ -66,7 +64,6 @@ books: url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT git_name: automotive-grade-linux/docs-sources - git_commit: sandbox/benierc/newdocs path: docs/audio-book.yml dst_prefix: audio books: @@ -83,7 +80,6 @@ books: url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT git_name: automotive-grade-linux/docs-sources - git_commit: sandbox/benierc/newdocs path: docs/hmi-framework-book.yml dst_prefix: hmi-framework books: -- cgit From 46c7f782edc47fc3bb58b149ec1e0c4a37fa7d66 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Sun, 24 Feb 2019 16:46:22 +0100 Subject: section_flouder apiservices: updated MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/apis_services/section_flounder.yml | 154 ++++++++++++------------ 1 file changed, 76 insertions(+), 78 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/apis_services/section_flounder.yml b/content/tocs/apis_services/section_flounder.yml index ceb1912..c365671 100644 --- a/content/tocs/apis_services/section_flounder.yml +++ b/content/tocs/apis_services/section_flounder.yml @@ -1,108 +1,106 @@ url_fetch : "GERRIT_FETCH" -git_commit : "flounder" +git_commit : flounder name: APIs & Services template: generated_index.html books: - - id: app-framework-main-developer-guides-flounder + id: flounder-app-framework-main-developer-guides git_name: src/app-framework-main path: docs/api-services-book.yml dst_prefix: af-main - - id: app-framework-binder-developer-guides-flounder + id: flounder-app-framework-binder-developer-guides git_name: src/app-framework-binder path: docs/api-services-book.yml dst_prefix: af-binder - - id: agl-service-can-low-level-developer-guides-flounder - git_name: apps/agl-service-can-low-level - path: docs/api-services-book.yml - dst_prefix: signaling -- - id: app-afb-test-developer-guides-flounder + id: flounder-app-afb-test-developer-guides git_name: apps/app-afb-test path: docs/api-services-book.yml dst_prefix: afb-test - - id: high-level-developer-guides-flounder - url_fetch: GITHUB_FETCH - url_edit: GITHUB_EDIT - git_name: iotbzh/high-level-viwi-service - git_commit: master - path: docs/api-services-book.yml - dst_prefix: signaling -- - id: agl-service-signal-composer-developer-guides-flounder - git_name: apps/agl-service-signal-composer - path: docs/api-services-book.yml -- - id: candevstudio-developer-guides-flounder - url_fetch: GITHUB_FETCH - url_edit: GITHUB_EDIT - git_name: iotbzh/agl-documentation - git_commit: master - path: candevstudio/docs/api-services-book.yml - dst_prefix: candevstudio -- - id: app-framework-developer-guides-flounder - url_fetch: GITHUB_FETCH - url_edit: AGL_GITHUB_EDIT - git_name: automotive-grade-linux/docs-sources - git_commit: sandbox/benierc/newdocs - path: docs/app-framework-book.yml - dst_prefix: af-binder -- - id: signaling-developer-guides-flounder - url_fetch: GITHUB_FETCH + id: flounder-docs-source-signaling + url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT git_name: automotive-grade-linux/docs-sources - git_commit: sandbox/benierc/newdocs path: docs/signaling-book.yml - src_prefix: docs/signaling -# FIXME -# - -# id: devel-guidelines-2016-flounder -# url_fetch: https://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 -- - id: audio-developer-guides-flounder + dst_prefix: signaling + books: + - id: flounder-agl-service-can-low-level-developer-guides + git_name: apps/agl-service-can-low-level + path: docs/api-services-book.yml + dst_prefix: signaling + - id: flounder-high-level-developer-guides + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_commit: master + git_name: iotbzh/high-level-viwi-service + path: docs/api-services-book.yml + dst_prefix: signaling + - id: flounder-agl-service-signal-composer-developer-guides + git_name: apps/agl-service-signal-composer + path: docs/api-services-book.yml + - id: flounder-devel-appfw-guidelines-2016 + path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf + dst_prefix: iotbzh2016 + name: Developer Guidelines + - id: flounder-devel-message-guidelines-2016 + path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf + dst_prefix: iotbzh2016 + name: CAN Signaling Benchmark + - id: flounder-candevstudio-developer-guides + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_commit: master + git_name: iotbzh/agl-documentation + path: candevstudio/docs/api-services-book.yml + dst_prefix: candevstudio + - id: flounder-app-framework-developer-guides + url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + path: docs/app-framework-book.yml + dst_prefix: af-binder +- + id: flounder-audio-developer-guides url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT git_name: automotive-grade-linux/docs-sources - git_commit: sandbox/benierc/newdocs path: docs/audio-book.yml dst_prefix: audio -- - id: agl-service-audio-4a-developer-guides-flounder - git_name: apps/agl-service-audio-4a - path: docs/api-services-book.yml - dst_prefix: audio -- - id: pulseaudio-module-4a-developer-guides-flounder - git_name: src/pulseaudio-module-4a - path: api-services-book.yml - dst_prefix: audio -- - id: agl-service-homescreen-developer-guides-flounder - git_name: apps/agl-service-homescreen - path: doc/api-services-book.yml - dst_prefix: hmi-framework -- - id: agl-service-windowmanager-developer-guides-flounder - git_name: apps/agl-service-windowmanager - path: doc/api-services-book.yml - dst_prefix: hmi-framework -- - id: agl-service-soundmanager-developer-guides-flounder - git_name: apps/agl-service-soundmanager - path: doc/api-services-book.yml + books: + - id: flounder-pulseaudio-module-4a-developer-guides + git_name: src/pulseaudio-module-4a + path: api-services-book.yml + dst_prefix: audio + - id: flounder-agl-service-audio-4a-developer-guides + git_name: apps/agl-service-audio-4a + path: docs/api-services-book.yml + dst_prefix: audio +- + id: flounder-hmi-framework + url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + path: docs/hmi-framework-book.yml dst_prefix: hmi-framework -- - id: homescreen-developer-guides-flounder + books: + - id: flounder-agl-service-homescreen-developer-guides + name: HMI Framework + git_name: apps/agl-service-homescreen + path: doc/api-services-book.yml + dst_prefix: hmi-framework + - id: flounder-agl-service-windowmanager-developer-guides + git_name: apps/agl-service-windowmanager + path: doc/api-services-book.yml + dst_prefix: hmi-framework + - id: flounder-agl-service-soundmanager-developer-guides + git_name: apps/agl-service-soundmanager + path: doc/api-services-book.yml + dst_prefix: hmi-framework +- + id: flounder-homescreen-developer-guides git_name: apps/homescreen path: homescreen/docs/api-services-book.yml dst_prefix: hmi-framework -- cgit From f00f68e3aff82781b82e3162026d899b3b8d946f Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Sun, 24 Feb 2019 18:18:53 +0100 Subject: devguides sections: updated MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/devguides/section_flounder.yml | 37 ++++++++++++++++--------- content/tocs/devguides/section_master.yml | 42 ++++++++++++++++++----------- 2 files changed, 50 insertions(+), 29 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/devguides/section_flounder.yml b/content/tocs/devguides/section_flounder.yml index 0fbb492..544ba4e 100644 --- a/content/tocs/devguides/section_flounder.yml +++ b/content/tocs/devguides/section_flounder.yml @@ -16,11 +16,6 @@ books: id: meta-agl-devel-guides-flounder git_name: AGL/meta-agl-devel path: docs/devguides-book.yml -#- -# url_fetch: https://iot.bzh/download/public/2016/%source% -# dst_prefix: iotbzh2016 -# documents: -# - source: appfw/03-AGL-AppFW-Privileges-Management.pdf - id: host-configuration-developer-guides-flounder url_fetch: GITHUB_FETCH @@ -38,18 +33,34 @@ books: git_name: src/xds/xds-docs path: docs/devguides-book.yml dst_prefix: "xds" -#- -# 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 +- + 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_commit: master + 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_master.yml b/content/tocs/devguides/section_master.yml index f3bc7ec..5265840 100644 --- a/content/tocs/devguides/section_master.yml +++ b/content/tocs/devguides/section_master.yml @@ -1,5 +1,4 @@ url_fetch : "GERRIT_FETCH" -git_commit : "AGL_GERRIT_BRANCH" name: Developers Guides template: generated_index.html @@ -16,11 +15,6 @@ books: id: meta-agl-devel-guides git_name: AGL/meta-agl-devel path: docs/devguides-book.yml -#- -# url_fetch: https://iot.bzh/download/public/2016/%source% -# dst_prefix: iotbzh2016 -# documents: -# - source: appfw/03-AGL-AppFW-Privileges-Management.pdf - id: host-configuration-developer-guides url_fetch: GITHUB_FETCH @@ -37,18 +31,34 @@ books: git_name: src/xds/xds-docs path: docs/devguides-book.yml dst_prefix: "xds" -#- -# 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 +- + 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) \ No newline at end of file -- cgit From ef645c361358270b631f8d0971b8210bed070373 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Sun, 24 Feb 2019 18:46:19 +0100 Subject: sections architecture getting started: updated MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/architecture/section_flounder.yml | 11 ++++------- content/tocs/architecture/section_master.yml | 11 ++++------- content/tocs/getting_started/section_flounder.yml | 7 ++----- content/tocs/getting_started/section_master.yml | 3 --- 4 files changed, 10 insertions(+), 22 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/architecture/section_flounder.yml b/content/tocs/architecture/section_flounder.yml index 20aa1d6..8f74d2c 100644 --- a/content/tocs/architecture/section_flounder.yml +++ b/content/tocs/architecture/section_flounder.yml @@ -6,13 +6,10 @@ git_commit : "sandbox/benierc/newdocs" name: Developer Guides template: generated_index.html books: -# FIXME: fix support of pdf source -# - -# id: agl_specifications-flounder -# url_fetch: AGL_GITHUB_FETCH -# git_name: automotive-grade-linux/docs-sources -# dst_prefix: AGL_Specifications -# path: docs/agl-specs-book.yml +- + id: agl-specifications + path: https://wiki.automotivelinux.org/_media/agl_spec_v1.0_final.pdf + name: AGL Requirements Specifications - id: security_blueprint-flounder url_fetch: AGL_GITHUB_FETCH diff --git a/content/tocs/architecture/section_master.yml b/content/tocs/architecture/section_master.yml index 7764a1c..2ce9e31 100644 --- a/content/tocs/architecture/section_master.yml +++ b/content/tocs/architecture/section_master.yml @@ -6,13 +6,10 @@ git_commit : "sandbox/benierc/newdocs" name: Developer Guides template: generated_index.html books: -# FIXME: fix support of pdf source -# - -# id: agl_specifications -# url_fetch: AGL_GITHUB_FETCH -# git_name: automotive-grade-linux/docs-sources -# dst_prefix: AGL_Specifications -# path: docs/agl-specs-book.yml +- + id: agl-specifications + path: https://wiki.automotivelinux.org/_media/agl_spec_v1.0_final.pdf + name: AGL Requirements Specifications - id: security_blueprint url_fetch: AGL_GITHUB_FETCH diff --git a/content/tocs/getting_started/section_flounder.yml b/content/tocs/getting_started/section_flounder.yml index 3e05b78..51644bf 100644 --- a/content/tocs/getting_started/section_flounder.yml +++ b/content/tocs/getting_started/section_flounder.yml @@ -1,19 +1,16 @@ url_fetch : "GERRIT_FETCH" -git_commit : "flounder" name: Getting started template: generated_index.html books: - - id: image-development-workflow-flounder + id: flounder-image-development-workflow url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - # FIXME: delete line below to switch back to AGL_GERRIT_BRANCH - git_commit: sandbox/benierc/newdocs git_name: automotive-grade-linux/docs-sources path: docs/getting-started-book.yml - - id: apps-homescreen-flounder + id: flounder-apps-homescreen url_fetch: GERRIT_FETCH git_name: apps/homescreen dst_prefix: homescreen diff --git a/content/tocs/getting_started/section_master.yml b/content/tocs/getting_started/section_master.yml index 418c3b0..4777c8d 100644 --- a/content/tocs/getting_started/section_master.yml +++ b/content/tocs/getting_started/section_master.yml @@ -1,5 +1,4 @@ url_fetch : "GERRIT_FETCH" -git_commit : "AGL_GERRIT_BRANCH" name: Getting started template: generated_index.html @@ -8,8 +7,6 @@ books: id: image-development-workflow url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - # FIXME: delete line below to switch back to AGL_GERRIT_BRANCH - git_commit: sandbox/benierc/newdocs git_name: automotive-grade-linux/docs-sources path: docs/getting-started-book.yml - -- cgit From d7d996afa4d37e7cfa6128cfa6f7bc5811d811f8 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Sun, 24 Feb 2019 19:00:38 +0100 Subject: getting-started flounder: docs-sources master MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/getting_started/section_flounder.yml | 1 + 1 file changed, 1 insertion(+) (limited to 'content/tocs') diff --git a/content/tocs/getting_started/section_flounder.yml b/content/tocs/getting_started/section_flounder.yml index 51644bf..0de0487 100644 --- a/content/tocs/getting_started/section_flounder.yml +++ b/content/tocs/getting_started/section_flounder.yml @@ -7,6 +7,7 @@ books: id: flounder-image-development-workflow url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master git_name: automotive-grade-linux/docs-sources path: docs/getting-started-book.yml - -- cgit From 75e8ef2afae56b86a8fa14cfedb43cd788d203b5 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Sun, 24 Feb 2019 19:01:33 +0100 Subject: howto and reference sections added MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/howto/section_master.yml | 4 ++++ content/tocs/reference/section_master.yml | 4 ++++ 2 files changed, 8 insertions(+) create mode 100644 content/tocs/howto/section_master.yml create mode 100644 content/tocs/reference/section_master.yml (limited to 'content/tocs') diff --git a/content/tocs/howto/section_master.yml b/content/tocs/howto/section_master.yml new file mode 100644 index 0000000..6c1bbe0 --- /dev/null +++ b/content/tocs/howto/section_master.yml @@ -0,0 +1,4 @@ +url_fetch : "GERRIT_FETCH" + +name: How To +template: generated_index.html diff --git a/content/tocs/reference/section_master.yml b/content/tocs/reference/section_master.yml new file mode 100644 index 0000000..6c1bbe0 --- /dev/null +++ b/content/tocs/reference/section_master.yml @@ -0,0 +1,4 @@ +url_fetch : "GERRIT_FETCH" + +name: How To +template: generated_index.html -- cgit From a20ad67df6524ec0fc2f6cd633e0ff6a85a9f7f0 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Sun, 24 Feb 2019 19:20:54 +0100 Subject: howto: add handle doc information MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/howto/section_master.yml | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'content/tocs') diff --git a/content/tocs/howto/section_master.yml b/content/tocs/howto/section_master.yml index 6c1bbe0..ba3d899 100644 --- a/content/tocs/howto/section_master.yml +++ b/content/tocs/howto/section_master.yml @@ -2,3 +2,11 @@ url_fetch : "GERRIT_FETCH" name: How To template: generated_index.html +books: +- + id: howto-add-docs + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + path: docs/handle-docs-book.yml + -- cgit From b6b48a138a5100190f33a71a526f774b94514315 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Sun, 24 Feb 2019 19:21:40 +0100 Subject: add guppy sections MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/apis_services/section_guppy.yml | 109 +++++++++++++++++++++++++ content/tocs/architecture/section_guppy.yml | 19 +++++ content/tocs/devguides/section_guppy.yml | 68 +++++++++++++++ content/tocs/getting_started/section_guppy.yml | 18 ++++ content/tocs/hardware/section_guppy.yml | 11 +++ content/tocs/howto/section_guppy.yml | 13 +++ content/tocs/reference/section_guppy.yml | 4 + 7 files changed, 242 insertions(+) create mode 100644 content/tocs/apis_services/section_guppy.yml create mode 100644 content/tocs/architecture/section_guppy.yml create mode 100644 content/tocs/devguides/section_guppy.yml create mode 100644 content/tocs/getting_started/section_guppy.yml create mode 100644 content/tocs/hardware/section_guppy.yml create mode 100644 content/tocs/howto/section_guppy.yml create mode 100644 content/tocs/reference/section_guppy.yml (limited to 'content/tocs') diff --git a/content/tocs/apis_services/section_guppy.yml b/content/tocs/apis_services/section_guppy.yml new file mode 100644 index 0000000..d339eb1 --- /dev/null +++ b/content/tocs/apis_services/section_guppy.yml @@ -0,0 +1,109 @@ +url_fetch : "GERRIT_FETCH" + +name: APIs & Services +template: generated_index.html +books: +- + id: app-framework-main-developer-guides + git_name: src/app-framework-main + path: docs/api-services-book.yml + dst_prefix: af-main +- + id: app-framework-binder-developer-guides + git_name: src/app-framework-binder + path: docs/api-services-book.yml + dst_prefix: af-binder +- + id: app-afb-test-developer-guides + git_name: apps/app-afb-test + path: docs/api-services-book.yml + dst_prefix: afb-test +- + id: docs-source-signaling + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_commit: master + git_name: automotive-grade-linux/docs-sources + path: docs/signaling-book.yml + dst_prefix: signaling + books: + - id: agl-service-can-low-level-developer-guides + git_name: apps/agl-service-can-low-level + path: docs/api-services-book.yml + dst_prefix: signaling + - id: high-level-developer-guides + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_commit: master + git_name: iotbzh/high-level-viwi-service + path: docs/api-services-book.yml + dst_prefix: signaling + - id: agl-service-signal-composer-developer-guides + git_name: apps/agl-service-signal-composer + path: docs/api-services-book.yml + - id: devel-appfw-guidelines-2016 + path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf + dst_prefix: iotbzh2016 + name: Developer Guidelines + - id: devel-message-guidelines-2016 + path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf + dst_prefix: iotbzh2016 + name: CAN Signaling Benchmark + - id: candevstudio-developer-guides + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_commit: master + git_name: iotbzh/agl-documentation + path: candevstudio/docs/api-services-book.yml + dst_prefix: candevstudio + - id: app-framework-developer-guides + url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_commit: master + git_name: automotive-grade-linux/docs-sources + path: docs/app-framework-book.yml + dst_prefix: af-binder +- + id: audio-developer-guides + url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_commit: master + git_name: automotive-grade-linux/docs-sources + path: docs/audio-book.yml + dst_prefix: audio + books: + - id: pulseaudio-module-4a-developer-guides + git_name: src/pulseaudio-module-4a + path: api-services-book.yml + dst_prefix: audio + - id: agl-service-audio-4a-developer-guides + git_name: apps/agl-service-audio-4a + path: docs/api-services-book.yml + dst_prefix: audio +- + id: hmi-framework + url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_commit: master + git_name: automotive-grade-linux/docs-sources + path: docs/hmi-framework-book.yml + dst_prefix: hmi-framework + books: + - id: agl-service-homescreen-developer-guides + name: HMI Framework + git_name: apps/agl-service-homescreen + path: doc/api-services-book.yml + dst_prefix: hmi-framework + - id: agl-service-windowmanager-developer-guides + git_name: apps/agl-service-windowmanager + path: doc/api-services-book.yml + dst_prefix: hmi-framework + - id: agl-service-soundmanager-developer-guides + git_name: apps/agl-service-soundmanager + path: doc/api-services-book.yml + dst_prefix: hmi-framework +- + id: homescreen-developer-guides + git_name: apps/homescreen + path: homescreen/docs/api-services-book.yml + dst_prefix: hmi-framework diff --git a/content/tocs/architecture/section_guppy.yml b/content/tocs/architecture/section_guppy.yml new file mode 100644 index 0000000..2ce9e31 --- /dev/null +++ b/content/tocs/architecture/section_guppy.yml @@ -0,0 +1,19 @@ +url_fetch : "GERRIT_FETCH" +# FIXME: restore line below to switch back on master: +#git_commit : "AGL_GERRIT_BRANCH" +git_commit : "sandbox/benierc/newdocs" + +name: Developer Guides +template: generated_index.html +books: +- + id: agl-specifications + path: https://wiki.automotivelinux.org/_media/agl_spec_v1.0_final.pdf + name: AGL Requirements Specifications +- + id: security_blueprint + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + dst_prefix: security + path: docs/security-blueprint-book.yml diff --git a/content/tocs/devguides/section_guppy.yml b/content/tocs/devguides/section_guppy.yml new file mode 100644 index 0000000..d76b0d7 --- /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 +- + 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_commit: master + 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/getting_started/section_guppy.yml b/content/tocs/getting_started/section_guppy.yml new file mode 100644 index 0000000..45cfac6 --- /dev/null +++ b/content/tocs/getting_started/section_guppy.yml @@ -0,0 +1,18 @@ +url_fetch : "GERRIT_FETCH" + +name: Getting started +template: generated_index.html +books: +- + id: image-development-workflow + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_commit: master + git_name: automotive-grade-linux/docs-sources + path: docs/getting-started-book.yml +- + id: apps-homescreen + url_fetch: GERRIT_FETCH + git_name: apps/homescreen + dst_prefix: homescreen + path: homescreen/docs/homescreen-book.yml diff --git a/content/tocs/hardware/section_guppy.yml b/content/tocs/hardware/section_guppy.yml new file mode 100644 index 0000000..e0b95d9 --- /dev/null +++ b/content/tocs/hardware/section_guppy.yml @@ -0,0 +1,11 @@ +url_fetch : "GERRIT_FETCH" +git_commit : "AGL_GERRIT_BRANCH" + +name: Hardware Support +template: generated_index.html +books: +- + id: renesas-gen3-boards + git_name: AGL/meta-renesas-rcar-gen3 + path: meta-rcar-gen3/docs-book.yml + dst_prefix: renesas-gen3 diff --git a/content/tocs/howto/section_guppy.yml b/content/tocs/howto/section_guppy.yml new file mode 100644 index 0000000..2a1d0a5 --- /dev/null +++ b/content/tocs/howto/section_guppy.yml @@ -0,0 +1,13 @@ +url_fetch : "GERRIT_FETCH" + +name: How To +template: generated_index.html +books: +- + id: howto-add-docs + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_commit: master + git_name: automotive-grade-linux/docs-sources + path: docs/handle-docs-book.yml + diff --git a/content/tocs/reference/section_guppy.yml b/content/tocs/reference/section_guppy.yml new file mode 100644 index 0000000..6c1bbe0 --- /dev/null +++ b/content/tocs/reference/section_guppy.yml @@ -0,0 +1,4 @@ +url_fetch : "GERRIT_FETCH" + +name: How To +template: generated_index.html -- cgit From c0fafcb577abb8108490540f7ecfe949a92c7fd0 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Sun, 24 Feb 2019 20:05:22 +0100 Subject: reset tocs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/apis_services/fetched_files.yml | 420 +++++++++++++++++++++++++ content/tocs/apis_services/toc_dev_en.yml | 181 +++++++++++ content/tocs/architecture/fetched_files.yml | 140 +++++++++ content/tocs/architecture/toc_dev_en.yml | 106 +++++++ content/tocs/devguides/fetched_files.yml | 174 ++++++++++ content/tocs/devguides/toc_dev_en.yml | 258 +++++++++++++++ content/tocs/getting_started/fetched_files.yml | 120 +++++++ content/tocs/getting_started/toc_dev_en.yml | 85 +++++ content/tocs/hardware/fetched_files.yml | 56 ++++ content/tocs/hardware/toc_dev_en.yml | 45 +++ 10 files changed, 1585 insertions(+) create mode 100644 content/tocs/apis_services/fetched_files.yml create mode 100644 content/tocs/apis_services/toc_dev_en.yml create mode 100644 content/tocs/architecture/fetched_files.yml create mode 100644 content/tocs/architecture/toc_dev_en.yml create mode 100644 content/tocs/devguides/fetched_files.yml create mode 100644 content/tocs/devguides/toc_dev_en.yml create mode 100644 content/tocs/getting_started/fetched_files.yml create mode 100644 content/tocs/getting_started/toc_dev_en.yml create mode 100644 content/tocs/hardware/fetched_files.yml create mode 100644 content/tocs/hardware/toc_dev_en.yml (limited to 'content/tocs') diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml new file mode 100644 index 0000000..f1709a0 --- /dev/null +++ b/content/tocs/apis_services/fetched_files.yml @@ -0,0 +1,420 @@ +############################################################################################################## +# GLOBAL DOCUMENT +# : 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 + src_prefix: docs + dst_prefix: af-main + documents: + - source: 0-introduction.md + label: Introduction + - source: 0-kristi-introduction.md + label: API Reference + - 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 + src_prefix: docs + dst_prefix: af-binder + documents: + - source: index.md + label: Binder index + - source: afb-overview.md + label: Overview + - source: afb-binding-writing.md + label: How to write a binding ? + - source: afb-binding-references.md + label: Binding references + - source: reference-v3/types-and-globals.md + label: Types and globals + - source: reference-v3/func-api.md + label: Functions of class afb_api + - source: reference-v3/func-req.md + label: Functions of class afb_req + - source: reference-v3/func-event.md + label: Functions of class afb_event + - source: reference-v3/func-daemon.md + label: Functions of class afb_daemon + - source: reference-v3/func-service.md + label: Functions of class afb_service + - source: reference-v3/macro-log.md + label: Macros for logging + - source: afb-migration-to-binding-v3.md + label: Migration to bindings v3 + - 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-debugging.md + label: Debugging binder and bindings + - source: afb-daemon-options.md + label: Options of afb-daemon + - source: protocol-x-afb-ws-json1.md + label: WebSocket protocol x-afb-ws-json1 + - source: annexes.md + label: Annexes + - source: REVISIONS.md + label: Document revision + - source: legacy/afb-migration-v1-to-v2.md + label: LEGACY Migration from v1 to v2 + - source: legacy/afb-binding-v2-references.md + label: LEGACY Binding V2 references + - 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 + +- + git_name: apps/agl-service-can-low-level + 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 + +- + git_name: apps/app-afb-test + src_prefix: docs + dst_prefix: afb-test + documents: + - source: 0_Installation.md + destination: Installation.md + label: Installation + - source: 1_Write_the_tests.md + destination: write-the-tests.md + label: Write the tests + - source: 2_The_test_widget.md + destination: the-test-widget.md + label: The test widget + - source: 3_Launch_the_tests.md + destination: launch-the-tests.md + label: Launch the tests + - source: 4_Tests_Examples.md + destination: tests-examples.md + label: Tests examples + - source: Reference/0_BindingTestFunctions.md + destination: binding-test-functions.md + label: Binding Test Functions + - source: Reference/1_BindingAssertFunctions.md + destination: binding-assert-functions.md + label: Binding Assert Functions + - source: Reference/2_TestFrameworkFunctions.md + destination: test-framework-functions.md + label: Test Framework Functions + - source: Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md + destination: general-assertions.md + label: General Assertions + - source: Reference/LuaUnitAssertionFunctions/1_ValueAssertions.md + destination: value-assertions.md + label: Value Assertions + - source: Reference/LuaUnitAssertionFunctions/2_ScientificAssertions.md + destination: scientific-assertions.md + label: Scientific Assertions + - source: Reference/LuaUnitAssertionFunctions/3_StringAssertions.md + destination: string-assertions.md + label: String Assertions + - source: Reference/LuaUnitAssertionFunctions/4_ErrorAssertions.md + destination: error-assertions.md + label: Error Assertions + - source: Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md + destination: type-assertions.md + label: Type Assertions + - source: Reference/LuaUnitAssertionFunctions/6_TableAssertions.md + destination: table-assertions.md + label: Table Assertions + +- + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + 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 +- + git_name: apps/agl-service-signal-composer + src_prefix: docs/part-1/ + dst_prefix: signaling + documents: + - source: 1-Architecture.md + destination: signal-composer-architecture.md + label: Architecture presentation + - source: 2-Configuration.md + destination: signal-composer-configuration.md + label: Configuration + - source: 3-Plugins.md + destination: signal-composer-plugins.md + label: Plugins + - source: 4-SignalComposerAPI.md + destination: signal-composer-api.md + label: Signal Composer API + - source: pictures/Global_Signaling_Architecture.png + - source: pictures/iotbzh_logo_small.png +- + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: iotbzh/agl-documentation + git_commit: master + documents: + - source: candevstudio/docs/1_Usage.md + - source: candevstudio/docs/2_can_device_socketcan_backend.md + - source: candevstudio/docs/3_Add_CAN_Device.md + - source: candevstudio/docs/4_Configure_CanRawSender_Node.md + - source: candevstudio/docs/5_Using_CanRawView.md + - source: candevstudio/docs/pictures/CANdevStudio.png + - source: candevstudio/docs/pictures/canrawsender.png + - source: candevstudio/docs/pictures/canrawviewer.png + +- + 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/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: automotive-grade-linux/docs-sources + git_commit: AGL_GITHUB_BRANCH + src_prefix: docs/signaling + dst_prefix: signaling + documents: + - source: architecture.md + destination: architecture.md + label: Signaling Architecture + - 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 +- + url_fetch: https://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: automotive-grade-linux/docs-sources + git_commit: AGL_GITHUB_BRANCH + src_prefix: docs/audio + dst_prefix: audio + documents: + - source: 4a-framework.md + destination: 4a-framework.md + label: 4a-framework + - source: bluez-alsa.md + destination: bluez-alsa.md + label: bluez-alsa +- + git_name: apps/agl-service-audio-4a + src_prefix: docs + dst_prefix: audio + documents: + - source: 4a-framework/README.md + label: Architecture + - source: 4a-framework/concepts.md + label: Concepts + - source: 4a-framework/components.md + label: Components + - source: 4a-framework/images/4a-architecture.svg + - source: 4a-framework/images/apps-architecture.svg + - source: 4a-framework/images/agl-audio-arch.png + - source: high-level-api/README.md + label: Abstract + - source: high-level-api/kickstart.md + label: Kickstart + - source: high-level-api/reference.md + label: Reference + - source: high-level-api/TipsAndTricks/AdjustVolumes.md + label: Adjust volumes + - source: high-level-api/TipsAndTricks/4aTools.md + label: 4a-tools + - source: high-level-api/TipsAndTricks/Devices.md + label: Devices + - source: high-level-api/TipsAndTricks/HALs.md + label: HALs + - source: high-level-api/TipsAndTricks/images/changeSound.png + - source: high-level-api/TipsAndTricks/images/MixerBaseMenu.png +- + git_name: src/pulseaudio-module-4a + dst_prefix: audio + documents: + - source: README.md + destination: pulseaudio-module-4a.md + label: Pulseaudio - 4A Integration Module +- + git_name: apps/agl-service-homescreen + src_prefix: doc/ + dst_prefix: hmi-framework/ + documents: + - source: ApplicationGuide.md + destination: 3_1-HomeScreen-Guide.md + label: Home Screen Developper Guide + - source: parts/software-stack.png + - source: parts/initialize-set-event-handler.svg + - source: parts/tap_shortcut.svg + - source: parts/showWindow.svg + - source: parts/on_screen_message.svg + - source: parts/showOnScreen.svg + - source: parts/showNotification.svg + - source: parts/showInformation.svg +- + git_name: apps/agl-service-windowmanager + src_prefix: doc/ + dst_prefix: hmi-framework/ + documents: + - source: ApplicationGuide.md + destination: 3_2-WindowManager-Guide.md + label: Window Manager Developper Guide + - source: parts/state_change_example.png + - source: parts/wm_software_stack.png + - source: parts/wm_layer_stack.png + - source: parts/wm_area.png + - source: parts/request_role.png + - source: parts/hmi_framework_designed_seq_toyota.png + - source: parts/deactivate_window.png + - source: parts/example_split.png +- + git_name: apps/agl-service-soundmanager + 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 +- + 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..023e699 --- /dev/null +++ b/content/tocs/apis_services/toc_dev_en.yml @@ -0,0 +1,181 @@ +####################################################################### +# 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: : 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/architecture/toc_dev_en.yml b/content/tocs/architecture/toc_dev_en.yml new file mode 100644 index 0000000..25c6f36 --- /dev/null +++ b/content/tocs/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: : 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: 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: apps/app-controller-submodule + 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 diff --git a/content/tocs/devguides/toc_dev_en.yml b/content/tocs/devguides/toc_dev_en.yml new file mode 100644 index 0000000..f9bad98 --- /dev/null +++ b/content/tocs/devguides/toc_dev_en.yml @@ -0,0 +1,258 @@ +####################################################################### +# 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: : 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 +# ------------------------------------ +############################################################################################################## + +#dst_prefix: # destination_path = destination_prefix + (document.destination || document.source) + +url_fetch: GERRIT_FETCH +git_commit: AGL_GERRIT_BRANCH + +repositories: +- + 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/getting-started + documents : + - source: getting-started-welcome.md + label: Overview + - source: app-workflow-intro.md + label: Overview + - source: app-workflow-image.md + label: Download or Build Your Image + - source: app-workflow-sdk.md + label: Download or Build Your SDK Installer + - source: app-workflow-bootables.md + label: Create Bootable Media + - source: app-workflow-boot.md + label: Boot the Image on the Board + - source: app-workflow-prep-app.md + label: Get Ready to Create Your Application + - source: app-workflow-build-app.md + label: Create and Build the Application + - source: app-workflow-deploy-app.md + label: Deploy the Application to the Board + - source: app-workflow-debug-app.md + label: Debug the Application + - source: images/app-developer-workflow.png + destination: images/app-developer-workflow.png + - source: image-workflow-intro.md + label: Overview + - source: image-workflow-prep-host.md + label: Preparing Your Build Host + - source: image-workflow-download-sw.md + label: Downloading AGL Software + - source: image-workflow-initialize-build-environment.md + label: Initializing Your Build Environment + - source: image-workflow-cust-build.md + label: Customizing Your Build + - source: image-workflow-build.md + label: Building the AGL Image + - source: machines/intel.md + label: Building for Most Intel 64-Bit Hardware Platforms + - source: machines/qemu.md + label: Building for Emulation + - source: machines/renesas.md + label: Building for Supported Renesas Boards + - source: machines/raspberrypi.md + label: Building for Raspberry PI 2 or 3 + - source: images/image-developer-workflow.png + destination: images/image-developer-workflow.png + - source: troubleshooting.md + label: Generic issues + - source: machines/images/RaspberryPi2-ModelB-debug-serial-cable.png + destination: machines/images/RaspberryPi2-ModelB-debug-serial-cable.png + - source: docker-container-setup.md + label: Overview +- + git_name: apps/homescreen + 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..8251337 --- /dev/null +++ b/content/tocs/getting_started/toc_dev_en.yml @@ -0,0 +1,85 @@ +####################################################################### +# 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: : 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 +# ------------------------------------ +############################################################################################################## + +#dst_prefix: # destination_path = destination_prefix + (document.destination || document.source) + +url_fetch: "GERRIT_FETCH" +git_commit: "AGL_GERRIT_BRANCH" + +repositories: +- + git_name: AGL/meta-renesas-rcar-gen3 + dst_prefix: renesas-gen3 + documents: + - source: meta-rcar-gen3/README + destination: gen3.md + label: meta-rcar-gen3 layer + - source: meta-rcar-gen3/README.proprietary + destination: proprietary.md + label: Proprietary drivers + diff --git a/content/tocs/hardware/toc_dev_en.yml b/content/tocs/hardware/toc_dev_en.yml new file mode 100644 index 0000000..6c49ed8 --- /dev/null +++ b/content/tocs/hardware/toc_dev_en.yml @@ -0,0 +1,45 @@ +####################################################################### +# 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: Date: Mon, 25 Feb 2019 11:58:36 +0100 Subject: docs-source switch to master-next MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/apis_services/section_flounder.yml | 4 ++++ content/tocs/apis_services/section_guppy.yml | 8 ++++---- content/tocs/apis_services/section_master.yml | 4 ++++ content/tocs/architecture/section_master.yml | 1 + content/tocs/devguides/section_flounder.yml | 2 +- content/tocs/devguides/section_guppy.yml | 2 +- content/tocs/devguides/section_master.yml | 3 ++- content/tocs/getting_started/section_flounder.yml | 2 +- content/tocs/getting_started/section_guppy.yml | 2 +- content/tocs/getting_started/section_master.yml | 1 + content/tocs/howto/section_guppy.yml | 2 +- content/tocs/howto/section_master.yml | 1 + 12 files changed, 22 insertions(+), 10 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/apis_services/section_flounder.yml b/content/tocs/apis_services/section_flounder.yml index c365671..b118ab1 100644 --- a/content/tocs/apis_services/section_flounder.yml +++ b/content/tocs/apis_services/section_flounder.yml @@ -23,6 +23,7 @@ books: id: flounder-docs-source-signaling url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/signaling-book.yml dst_prefix: signaling @@ -59,6 +60,7 @@ books: - id: flounder-app-framework-developer-guides url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/app-framework-book.yml dst_prefix: af-binder @@ -66,6 +68,7 @@ books: id: flounder-audio-developer-guides url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/audio-book.yml dst_prefix: audio @@ -82,6 +85,7 @@ books: id: flounder-hmi-framework url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/hmi-framework-book.yml dst_prefix: hmi-framework diff --git a/content/tocs/apis_services/section_guppy.yml b/content/tocs/apis_services/section_guppy.yml index d339eb1..c8f43ee 100644 --- a/content/tocs/apis_services/section_guppy.yml +++ b/content/tocs/apis_services/section_guppy.yml @@ -22,7 +22,7 @@ books: id: docs-source-signaling url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/signaling-book.yml dst_prefix: signaling @@ -59,7 +59,7 @@ books: - id: app-framework-developer-guides url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/app-framework-book.yml dst_prefix: af-binder @@ -67,7 +67,7 @@ books: id: audio-developer-guides url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/audio-book.yml dst_prefix: audio @@ -84,7 +84,7 @@ books: id: hmi-framework url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/hmi-framework-book.yml dst_prefix: hmi-framework diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml index e137e21..daffedf 100644 --- a/content/tocs/apis_services/section_master.yml +++ b/content/tocs/apis_services/section_master.yml @@ -22,6 +22,7 @@ books: id: docs-source-signaling url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/signaling-book.yml dst_prefix: signaling @@ -56,6 +57,7 @@ books: - id: app-framework-developer-guides url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/app-framework-book.yml dst_prefix: af-binder @@ -63,6 +65,7 @@ books: id: audio-developer-guides url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/audio-book.yml dst_prefix: audio @@ -79,6 +82,7 @@ books: id: hmi-framework url_fetch: GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/hmi-framework-book.yml dst_prefix: hmi-framework diff --git a/content/tocs/architecture/section_master.yml b/content/tocs/architecture/section_master.yml index 2ce9e31..fd4fe17 100644 --- a/content/tocs/architecture/section_master.yml +++ b/content/tocs/architecture/section_master.yml @@ -14,6 +14,7 @@ books: id: security_blueprint url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources dst_prefix: security path: docs/security-blueprint-book.yml diff --git a/content/tocs/devguides/section_flounder.yml b/content/tocs/devguides/section_flounder.yml index 544ba4e..1e1a4be 100644 --- a/content/tocs/devguides/section_flounder.yml +++ b/content/tocs/devguides/section_flounder.yml @@ -48,7 +48,7 @@ books: name: Continuous Integration - Automated Testing (CIAT) url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/continuous-integration-book.yml books: diff --git a/content/tocs/devguides/section_guppy.yml b/content/tocs/devguides/section_guppy.yml index d76b0d7..d61d6de 100644 --- a/content/tocs/devguides/section_guppy.yml +++ b/content/tocs/devguides/section_guppy.yml @@ -52,7 +52,7 @@ books: name: Continuous Integration - Automated Testing (CIAT) url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/continuous-integration-book.yml books: diff --git a/content/tocs/devguides/section_master.yml b/content/tocs/devguides/section_master.yml index 5265840..9359a20 100644 --- a/content/tocs/devguides/section_master.yml +++ b/content/tocs/devguides/section_master.yml @@ -51,6 +51,7 @@ books: name: Continuous Integration - Automated Testing (CIAT) url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/continuous-integration-book.yml books: @@ -61,4 +62,4 @@ books: - 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) \ No newline at end of file + name: How to write tests (detailed) diff --git a/content/tocs/getting_started/section_flounder.yml b/content/tocs/getting_started/section_flounder.yml index 0de0487..f22e8c1 100644 --- a/content/tocs/getting_started/section_flounder.yml +++ b/content/tocs/getting_started/section_flounder.yml @@ -7,7 +7,7 @@ books: id: flounder-image-development-workflow url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/getting-started-book.yml - diff --git a/content/tocs/getting_started/section_guppy.yml b/content/tocs/getting_started/section_guppy.yml index 45cfac6..b0c0230 100644 --- a/content/tocs/getting_started/section_guppy.yml +++ b/content/tocs/getting_started/section_guppy.yml @@ -7,7 +7,7 @@ books: id: image-development-workflow url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT - git_commit: master + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/getting-started-book.yml - diff --git a/content/tocs/getting_started/section_master.yml b/content/tocs/getting_started/section_master.yml index 4777c8d..b0c0230 100644 --- a/content/tocs/getting_started/section_master.yml +++ b/content/tocs/getting_started/section_master.yml @@ -7,6 +7,7 @@ books: id: image-development-workflow url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/getting-started-book.yml - diff --git a/content/tocs/howto/section_guppy.yml b/content/tocs/howto/section_guppy.yml index 2a1d0a5..b5af902 100644 --- a/content/tocs/howto/section_guppy.yml +++ b/content/tocs/howto/section_guppy.yml @@ -7,7 +7,7 @@ books: id: howto-add-docs url_fetch: GITHUB_FETCH url_edit: GITHUB_EDIT - git_commit: master + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/handle-docs-book.yml diff --git a/content/tocs/howto/section_master.yml b/content/tocs/howto/section_master.yml index ba3d899..b5af902 100644 --- a/content/tocs/howto/section_master.yml +++ b/content/tocs/howto/section_master.yml @@ -7,6 +7,7 @@ books: id: howto-add-docs url_fetch: GITHUB_FETCH url_edit: GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources path: docs/handle-docs-book.yml -- cgit From dc6cc0443f007a8cfa8786bf4d6bdf93a38a11c3 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Wed, 6 Mar 2019 14:35:53 +0100 Subject: appendBooks for meta-AGL MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/devguides/section_flounder.yml | 17 +++++++++-------- content/tocs/devguides/section_guppy.yml | 17 +++++++++-------- content/tocs/devguides/section_master.yml | 17 +++++++++-------- 3 files changed, 27 insertions(+), 24 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/devguides/section_flounder.yml b/content/tocs/devguides/section_flounder.yml index 1e1a4be..de4f6e6 100644 --- a/content/tocs/devguides/section_flounder.yml +++ b/content/tocs/devguides/section_flounder.yml @@ -8,14 +8,15 @@ books: id: meta-agl-developer-guides-flounder git_name: AGL/meta-agl path: docs/devguides-book.yml -- - 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 + appendBooks: + - + 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 diff --git a/content/tocs/devguides/section_guppy.yml b/content/tocs/devguides/section_guppy.yml index d61d6de..3f6bfc0 100644 --- a/content/tocs/devguides/section_guppy.yml +++ b/content/tocs/devguides/section_guppy.yml @@ -7,14 +7,15 @@ books: id: meta-agl-developer-guides git_name: AGL/meta-agl path: docs/devguides-book.yml -- - 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 + appendBooks: + - + 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 diff --git a/content/tocs/devguides/section_master.yml b/content/tocs/devguides/section_master.yml index 9359a20..1823df7 100644 --- a/content/tocs/devguides/section_master.yml +++ b/content/tocs/devguides/section_master.yml @@ -7,14 +7,15 @@ books: id: meta-agl-developer-guides git_name: AGL/meta-agl path: docs/devguides-book.yml -- - 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 + appendBooks: + - + 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 -- cgit From 6f3374f0d2adbba792a7a298a8a592a476e4d69f Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Mon, 11 Mar 2019 17:01:25 +0100 Subject: brotherBooks: rename appendBooks into brotherBooks MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - add brotherBooks entry when needed Signed-off-by: Clément Bénier --- content/tocs/apis_services/section_flounder.yml | 37 ++++++++++++--------- content/tocs/apis_services/section_guppy.yml | 43 ++++++++++++++----------- content/tocs/apis_services/section_master.yml | 37 ++++++++++++--------- content/tocs/devguides/section_flounder.yml | 2 +- content/tocs/devguides/section_guppy.yml | 2 +- content/tocs/devguides/section_master.yml | 2 +- 6 files changed, 69 insertions(+), 54 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/apis_services/section_flounder.yml b/content/tocs/apis_services/section_flounder.yml index b118ab1..f9a9015 100644 --- a/content/tocs/apis_services/section_flounder.yml +++ b/content/tocs/apis_services/section_flounder.yml @@ -27,6 +27,25 @@ books: git_name: automotive-grade-linux/docs-sources path: docs/signaling-book.yml dst_prefix: signaling + brotherBooks: + - id: flounder-devel-appfw-guidelines-2016 + order: 60 + path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf + dst_prefix: iotbzh2016 + name: Developer Guidelines + - id: flounder-devel-message-guidelines-2016 + order: 60 + path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf + dst_prefix: iotbzh2016 + name: CAN Signaling Benchmark + - id: flounder-app-framework-developer-guides + order: 80 + url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_commit: master-next + git_name: automotive-grade-linux/docs-sources + path: docs/app-framework-book.yml + dst_prefix: af-binder books: - id: flounder-agl-service-can-low-level-developer-guides git_name: apps/agl-service-can-low-level @@ -42,28 +61,14 @@ books: - id: flounder-agl-service-signal-composer-developer-guides git_name: apps/agl-service-signal-composer path: docs/api-services-book.yml - - id: flounder-devel-appfw-guidelines-2016 - path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf - dst_prefix: iotbzh2016 - name: Developer Guidelines - - id: flounder-devel-message-guidelines-2016 - path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf - dst_prefix: iotbzh2016 - name: CAN Signaling Benchmark - id: flounder-candevstudio-developer-guides + order: 70 url_fetch: GITHUB_FETCH url_edit: GITHUB_EDIT git_commit: master git_name: iotbzh/agl-documentation path: candevstudio/docs/api-services-book.yml dst_prefix: candevstudio - - id: flounder-app-framework-developer-guides - url_fetch: GITHUB_FETCH - url_edit: AGL_GITHUB_EDIT - git_commit: master-next - git_name: automotive-grade-linux/docs-sources - path: docs/app-framework-book.yml - dst_prefix: af-binder - id: flounder-audio-developer-guides url_fetch: GITHUB_FETCH @@ -89,7 +94,7 @@ books: git_name: automotive-grade-linux/docs-sources path: docs/hmi-framework-book.yml dst_prefix: hmi-framework - books: + brotherBooks: - id: flounder-agl-service-homescreen-developer-guides name: HMI Framework git_name: apps/agl-service-homescreen diff --git a/content/tocs/apis_services/section_guppy.yml b/content/tocs/apis_services/section_guppy.yml index c8f43ee..cce1fa1 100644 --- a/content/tocs/apis_services/section_guppy.yml +++ b/content/tocs/apis_services/section_guppy.yml @@ -26,6 +26,28 @@ books: git_name: automotive-grade-linux/docs-sources path: docs/signaling-book.yml dst_prefix: signaling + brotherBooks: + - id: agl-service-signal-composer-developer-guides + order: 60 + git_name: apps/agl-service-signal-composer + path: docs/api-services-book.yml + - id: devel-appfw-guidelines-2016 + path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf + dst_prefix: iotbzh2016 + order: 60 + name: Developer Guidelines + - id: devel-message-guidelines-2016 + path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf + dst_prefix: iotbzh2016 + name: CAN Signaling Benchmark + - id: app-framework-developer-guides + order: 80 + url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_commit: master-next + git_name: automotive-grade-linux/docs-sources + path: docs/app-framework-book.yml + dst_prefix: af-binder books: - id: agl-service-can-low-level-developer-guides git_name: apps/agl-service-can-low-level @@ -38,31 +60,14 @@ books: git_name: iotbzh/high-level-viwi-service path: docs/api-services-book.yml dst_prefix: signaling - - id: agl-service-signal-composer-developer-guides - git_name: apps/agl-service-signal-composer - path: docs/api-services-book.yml - - id: devel-appfw-guidelines-2016 - path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf - dst_prefix: iotbzh2016 - name: Developer Guidelines - - id: devel-message-guidelines-2016 - path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf - dst_prefix: iotbzh2016 - name: CAN Signaling Benchmark - id: candevstudio-developer-guides + order: 70 url_fetch: GITHUB_FETCH url_edit: GITHUB_EDIT git_commit: master git_name: iotbzh/agl-documentation path: candevstudio/docs/api-services-book.yml dst_prefix: candevstudio - - id: app-framework-developer-guides - url_fetch: GITHUB_FETCH - url_edit: AGL_GITHUB_EDIT - git_commit: master-next - git_name: automotive-grade-linux/docs-sources - path: docs/app-framework-book.yml - dst_prefix: af-binder - id: audio-developer-guides url_fetch: GITHUB_FETCH @@ -88,7 +93,7 @@ books: git_name: automotive-grade-linux/docs-sources path: docs/hmi-framework-book.yml dst_prefix: hmi-framework - books: + brotherBooks: - id: agl-service-homescreen-developer-guides name: HMI Framework git_name: apps/agl-service-homescreen diff --git a/content/tocs/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml index daffedf..273dfe8 100644 --- a/content/tocs/apis_services/section_master.yml +++ b/content/tocs/apis_services/section_master.yml @@ -26,6 +26,25 @@ books: git_name: automotive-grade-linux/docs-sources path: docs/signaling-book.yml dst_prefix: signaling + brotherBooks: + - id: devel-appfw-guidelines-2016 + order: 60 + path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf + dst_prefix: iotbzh2016 + name: Developer Guidelines + - id: devel-message-guidelines-2016 + order: 60 + path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf + dst_prefix: iotbzh2016 + name: CAN Signaling Benchmark + - id: app-framework-developer-guides + order: 80 + url_fetch: GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_commit: master-next + git_name: automotive-grade-linux/docs-sources + path: docs/app-framework-book.yml + dst_prefix: af-binder books: - id: agl-service-can-low-level-developer-guides git_name: apps/agl-service-can-low-level @@ -40,27 +59,13 @@ books: - id: agl-service-signal-composer-developer-guides git_name: apps/agl-service-signal-composer path: docs/api-services-book.yml - - id: devel-appfw-guidelines-2016 - path: https://iot.bzh/download/public/2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf - dst_prefix: iotbzh2016 - name: Developer Guidelines - - id: devel-message-guidelines-2016 - path: https://iot.bzh/download/public/2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf - dst_prefix: iotbzh2016 - name: CAN Signaling Benchmark - id: candevstudio-developer-guides + order: 70 url_fetch: GITHUB_FETCH url_edit: GITHUB_EDIT git_name: iotbzh/agl-documentation path: candevstudio/docs/api-services-book.yml dst_prefix: candevstudio - - id: app-framework-developer-guides - url_fetch: GITHUB_FETCH - url_edit: AGL_GITHUB_EDIT - git_commit: master-next - git_name: automotive-grade-linux/docs-sources - path: docs/app-framework-book.yml - dst_prefix: af-binder - id: audio-developer-guides url_fetch: GITHUB_FETCH @@ -86,7 +91,7 @@ books: git_name: automotive-grade-linux/docs-sources path: docs/hmi-framework-book.yml dst_prefix: hmi-framework - books: + brotherBooks: - id: agl-service-homescreen-developer-guides name: HMI Framework git_name: apps/agl-service-homescreen diff --git a/content/tocs/devguides/section_flounder.yml b/content/tocs/devguides/section_flounder.yml index de4f6e6..8f1036e 100644 --- a/content/tocs/devguides/section_flounder.yml +++ b/content/tocs/devguides/section_flounder.yml @@ -8,7 +8,7 @@ books: id: meta-agl-developer-guides-flounder git_name: AGL/meta-agl path: docs/devguides-book.yml - appendBooks: + brotherBooks: - id: meta-agl-demo-guides-flounder git_name: AGL/meta-agl-demo diff --git a/content/tocs/devguides/section_guppy.yml b/content/tocs/devguides/section_guppy.yml index 3f6bfc0..a1f86b9 100644 --- a/content/tocs/devguides/section_guppy.yml +++ b/content/tocs/devguides/section_guppy.yml @@ -7,7 +7,7 @@ books: id: meta-agl-developer-guides git_name: AGL/meta-agl path: docs/devguides-book.yml - appendBooks: + brotherBooks: - id: meta-agl-demo-guides git_name: AGL/meta-agl-demo diff --git a/content/tocs/devguides/section_master.yml b/content/tocs/devguides/section_master.yml index 1823df7..6cae842 100644 --- a/content/tocs/devguides/section_master.yml +++ b/content/tocs/devguides/section_master.yml @@ -7,7 +7,7 @@ books: id: meta-agl-developer-guides git_name: AGL/meta-agl path: docs/devguides-book.yml - appendBooks: + brotherBooks: - id: meta-agl-demo-guides git_name: AGL/meta-agl-demo -- cgit From 5e8034c5d4baca055ea423559993ac34d37c33cc Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Mon, 11 Mar 2019 18:07:08 +0100 Subject: architecture section: add git_commit master-next MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - remove sandbox/benierc/newdocs Signed-off-by: Clément Bénier --- content/tocs/architecture/section_flounder.yml | 2 +- content/tocs/architecture/section_guppy.yml | 2 +- content/tocs/architecture/section_master.yml | 1 - 3 files changed, 2 insertions(+), 3 deletions(-) (limited to 'content/tocs') diff --git a/content/tocs/architecture/section_flounder.yml b/content/tocs/architecture/section_flounder.yml index 8f74d2c..e38fb76 100644 --- a/content/tocs/architecture/section_flounder.yml +++ b/content/tocs/architecture/section_flounder.yml @@ -1,7 +1,6 @@ url_fetch : "GERRIT_FETCH" # FIXME: restore line below to switch back on master: #git_commit : "AGL_GERRIT_BRANCH" -git_commit : "sandbox/benierc/newdocs" name: Developer Guides template: generated_index.html @@ -14,6 +13,7 @@ books: id: security_blueprint-flounder url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources dst_prefix: security path: docs/security-blueprint-book.yml diff --git a/content/tocs/architecture/section_guppy.yml b/content/tocs/architecture/section_guppy.yml index 2ce9e31..9e20d2f 100644 --- a/content/tocs/architecture/section_guppy.yml +++ b/content/tocs/architecture/section_guppy.yml @@ -1,7 +1,6 @@ url_fetch : "GERRIT_FETCH" # FIXME: restore line below to switch back on master: #git_commit : "AGL_GERRIT_BRANCH" -git_commit : "sandbox/benierc/newdocs" name: Developer Guides template: generated_index.html @@ -14,6 +13,7 @@ books: id: security_blueprint url_fetch: AGL_GITHUB_FETCH url_edit: AGL_GITHUB_EDIT + git_commit: master-next git_name: automotive-grade-linux/docs-sources dst_prefix: security path: docs/security-blueprint-book.yml diff --git a/content/tocs/architecture/section_master.yml b/content/tocs/architecture/section_master.yml index fd4fe17..9e20d2f 100644 --- a/content/tocs/architecture/section_master.yml +++ b/content/tocs/architecture/section_master.yml @@ -1,7 +1,6 @@ url_fetch : "GERRIT_FETCH" # FIXME: restore line below to switch back on master: #git_commit : "AGL_GERRIT_BRANCH" -git_commit : "sandbox/benierc/newdocs" name: Developer Guides template: generated_index.html -- cgit