aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJan-Simon Moeller <jsmoeller@linuxfoundation.org>2020-03-03 00:44:09 +0100
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2020-03-03 00:44:09 +0100
commitf8ad051427fbdc5cdc268c2b0a4492929a3ede23 (patch)
treee50e812e5e6f961be9405f4e64536f9ae7597c6d
parentd28dc1123ed92ff333fe46c122a97a2391009915 (diff)
Ready doc page for icefish
Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
-rw-r--r--content/tocs/apis_services/section_icefish.yml113
-rw-r--r--content/tocs/apis_services/section_master.yml13
-rw-r--r--content/tocs/architecture/section_icefish.yml17
-rw-r--r--content/tocs/devguides/section_icefish.yml66
-rw-r--r--content/tocs/devguides/section_master.yml4
-rw-r--r--content/tocs/getting_started/section_icefish.yml18
-rw-r--r--content/tocs/hardware/section_icefish.yml11
-rw-r--r--content/tocs/hardware/section_master.yml2
-rw-r--r--content/tocs/howto/section_icefish.yml13
-rw-r--r--content/tocs/reference/section_icefish.yml5
10 files changed, 252 insertions, 10 deletions
diff --git a/content/tocs/apis_services/section_icefish.yml b/content/tocs/apis_services/section_icefish.yml
new file mode 100644
index 0000000..5ade398
--- /dev/null
+++ b/content/tocs/apis_services/section_icefish.yml
@@ -0,0 +1,113 @@
+url_fetch : "GERRIT_FETCH"
+git_commit : "icefish"
+
+name: APIs & Services
+template: generated_index.html
+books:
+-
+ id: api-reference-intro
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/api-reference-book.yml
+-
+ 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_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_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
+ path: docs/api-services-book.yml
+ dst_prefix: signaling
+ - id: high-level-developer-guides
+ git_name: apps/agl-service-can-high-level-viwi
+ 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: candevstudio-developer-guides
+ order: 70
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ path: agl-documentation/candevstudio/docs/api-services-book.yml
+ dst_prefix: candevstudio
+-
+ id: audio-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ 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_name: automotive-grade-linux/docs-sources
+ path: docs/hmi-framework-book.yml
+ dst_prefix: hmi-framework
+ brotherBooks:
+ - 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/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml
index 7799aa2..ee5996c 100644
--- a/content/tocs/apis_services/section_master.yml
+++ b/content/tocs/apis_services/section_master.yml
@@ -1,4 +1,5 @@
url_fetch : "GERRIT_FETCH"
+git_commit : "master"
name: APIs & Services
template: generated_index.html
@@ -55,9 +56,7 @@ books:
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
+ git_name: apps/agl-service-can-high-level-viwi
path: docs/api-services-book.yml
dst_prefix: signaling
- id: agl-service-signal-composer-developer-guides
@@ -65,10 +64,10 @@ books:
path: docs/api-services-book.yml
- 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
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ path: agl-documentation/candevstudio/docs/api-services-book.yml
dst_prefix: candevstudio
-
id: audio-developer-guides
diff --git a/content/tocs/architecture/section_icefish.yml b/content/tocs/architecture/section_icefish.yml
new file mode 100644
index 0000000..85b4a7d
--- /dev/null
+++ b/content/tocs/architecture/section_icefish.yml
@@ -0,0 +1,17 @@
+url_fetch : "GERRIT_FETCH"
+git_commit : "halibut"
+
+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_icefish.yml b/content/tocs/devguides/section_icefish.yml
new file mode 100644
index 0000000..cee6992
--- /dev/null
+++ b/content/tocs/devguides/section_icefish.yml
@@ -0,0 +1,66 @@
+url_fetch : "GERRIT_FETCH"
+git_commit : "icefish"
+
+name: Developers Guides
+template: generated_index.html
+books:
+-
+ id: meta-agl-developer-guides
+ git_name: AGL/meta-agl
+ path: docs/devguides-book.yml
+ brotherBooks:
+ -
+ id: meta-agl-demo-guides
+ git_name: AGL/meta-agl-demo
+ path: docs/devguides-book.yml
+ -
+ id: meta-agl-devel-guides
+ git_name: AGL/meta-agl-devel
+ path: docs/devguides-book.yml
+-
+ id: host-configuration-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ path: agl-documentation/host-configuration/docs/devguides-book.yml
+-
+ id: cmake-apps-module-guides
+ git_name: src/cmake-apps-module
+ path: docs/devguides-book.yml
+ dst_prefix: "cmakeafbtemplates"
+-
+ id: xds-docs-guides
+ git_name: src/xds/xds-docs
+ path: docs/devguides-book.yml
+ dst_prefix: "xds"
+-
+ id: appfw-privileges-management
+ path: https://iot.bzh/download/public/2016/appfw/03-AGL-AppFW-Privileges-Management.pdf
+ dst_prefix: iotbzh2016
+ name: AppFW - Privileges Management
+-
+ id: libappcontroller-guides
+ git_name: src/libappcontroller
+ path: docs/devguides-book.yml
+ dst_prefix: ctrler
+-
+ id: afb-helpers-function-references
+ git_name: src/libafb-helpers
+ path: docs/afb-helpers-book.yml
+ dst_prefix: afb-helpers
+-
+ id: continuous-integration-ciat
+ name: Continuous Integration - Automated Testing (CIAT)
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/continuous-integration-book.yml
+ books:
+ -
+ id: how-to-write-test-1
+ path: https://raw.githubusercontent.com/BayLibre/agl-docs-baylibre/master/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf
+ name: How to write tests (overview slides)
+ -
+ id: how-to-write-test-2
+ path: https://raw.githubusercontent.com/BayLibre/agl-docs-baylibre/master/CIAT/training/Hands_on_lab_documentation.pdf
+ name: How to write tests (detailed)
diff --git a/content/tocs/devguides/section_master.yml b/content/tocs/devguides/section_master.yml
index 9b1c489..491b0cd 100644
--- a/content/tocs/devguides/section_master.yml
+++ b/content/tocs/devguides/section_master.yml
@@ -21,8 +21,8 @@ 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
+ git_name: automotive-grade-linux/docs-sources
+ path: agl-documentation/host-configuration/docs/devguides-book.yml
-
id: cmake-apps-module-guides
git_name: src/cmake-apps-module
diff --git a/content/tocs/getting_started/section_icefish.yml b/content/tocs/getting_started/section_icefish.yml
new file mode 100644
index 0000000..c4c2484
--- /dev/null
+++ b/content/tocs/getting_started/section_icefish.yml
@@ -0,0 +1,18 @@
+url_fetch : "GERRIT_FETCH"
+git_commit : "icefish"
+
+name: Getting started
+template: generated_index.html
+books:
+-
+ id: image-development-workflow
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ 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_icefish.yml b/content/tocs/hardware/section_icefish.yml
new file mode 100644
index 0000000..94222c0
--- /dev/null
+++ b/content/tocs/hardware/section_icefish.yml
@@ -0,0 +1,11 @@
+url_fetch : "GERRIT_FETCH"
+git_commit : "icefish"
+
+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/hardware/section_master.yml b/content/tocs/hardware/section_master.yml
index e0b95d9..b37d235 100644
--- a/content/tocs/hardware/section_master.yml
+++ b/content/tocs/hardware/section_master.yml
@@ -1,5 +1,5 @@
url_fetch : "GERRIT_FETCH"
-git_commit : "AGL_GERRIT_BRANCH"
+git_commit : "master"
name: Hardware Support
template: generated_index.html
diff --git a/content/tocs/howto/section_icefish.yml b/content/tocs/howto/section_icefish.yml
new file mode 100644
index 0000000..14b7769
--- /dev/null
+++ b/content/tocs/howto/section_icefish.yml
@@ -0,0 +1,13 @@
+url_fetch : "GERRIT_FETCH"
+git_commit : "icefish"
+
+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
+
diff --git a/content/tocs/reference/section_icefish.yml b/content/tocs/reference/section_icefish.yml
new file mode 100644
index 0000000..081aac6
--- /dev/null
+++ b/content/tocs/reference/section_icefish.yml
@@ -0,0 +1,5 @@
+url_fetch : "GERRIT_FETCH"
+git_commit : "icefish"
+
+name: How To
+template: generated_index.html