diff options
author | 2019-02-24 20:05:42 +0100 | |
---|---|---|
committer | 2019-02-24 20:05:42 +0100 | |
commit | 1bd7ddd7abcd245d215d4150d09a1c32a6b6f3b0 (patch) | |
tree | 7b45981b52b1136a92d7700cdd4498a2509dd5f5 | |
parent | 0cb3c080e0e9d5d08db657d4433cf39b7d43b97e (diff) | |
parent | c0fafcb577abb8108490540f7ecfe949a92c7fd0 (diff) |
Merge branch 'sandbox/benierc/newdocstmp' into master-next
27 files changed, 763 insertions, 41 deletions
@@ -5,7 +5,10 @@ build-dev conf/_release.yml site/_data/all-pages.yml site/_data/tocs +site/_data/docs-versions.yml .fetch.ts .LocalFetch.ts doctools __* +node_modules/* +package-lock.json
\ No newline at end of file diff --git a/conf/_dev.yml b/conf/_dev.yml index 8bf011a..d281aa7 100644 --- a/conf/_dev.yml +++ b/conf/_dev.yml @@ -1,5 +1,5 @@ baseurl: "" -default_linked_docs_version: dev +default_linked_docs_version: master destination: build-dev exclude: - static/css-src diff --git a/content/tocs/apis_services/section_flounder.yml b/content/tocs/apis_services/section_flounder.yml new file mode 100644 index 0000000..c365671 --- /dev/null +++ b/content/tocs/apis_services/section_flounder.yml @@ -0,0 +1,106 @@ +url_fetch : "GERRIT_FETCH" +git_commit : flounder + +name: APIs & Services +template: generated_index.html +books: +- + id: flounder-app-framework-main-developer-guides + git_name: src/app-framework-main + path: docs/api-services-book.yml + dst_prefix: af-main +- + id: flounder-app-framework-binder-developer-guides + git_name: src/app-framework-binder + path: docs/api-services-book.yml + dst_prefix: af-binder +- + id: flounder-app-afb-test-developer-guides + git_name: apps/app-afb-test + path: docs/api-services-book.yml + dst_prefix: afb-test +- + id: flounder-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 + 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 + path: docs/audio-book.yml + dst_prefix: audio + 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 + 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 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/apis_services/section_master.yml b/content/tocs/apis_services/section_master.yml index d35c64b..e137e21 100644 --- a/content/tocs/apis_services/section_master.yml +++ b/content/tocs/apis_services/section_master.yml @@ -1,17 +1,103 @@ url_fetch : "GERRIT_FETCH" -git_commit : "AGL_GERRIT_BRANCH" -name: Developer Guides +name: APIs & Services 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%" + 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 + 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 + path: docs/app-framework-book.yml + dst_prefix: af-binder +- + 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 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: 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_flounder.yml b/content/tocs/architecture/section_flounder.yml new file mode 100644 index 0000000..8f74d2c --- /dev/null +++ b/content/tocs/architecture/section_flounder.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-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/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/architecture/section_master.yml b/content/tocs/architecture/section_master.yml new file mode 100644 index 0000000..2ce9e31 --- /dev/null +++ b/content/tocs/architecture/section_master.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_flounder.yml b/content/tocs/devguides/section_flounder.yml new file mode 100644 index 0000000..544ba4e --- /dev/null +++ b/content/tocs/devguides/section_flounder.yml @@ -0,0 +1,66 @@ +url_fetch : "GERRIT_FETCH" +git_commit : "flounder" + +name: Developers Guides +template: generated_index.html +books: +- + id: meta-agl-developer-guides-flounder + git_name: AGL/meta-agl + path: docs/devguides-book.yml +- + id: meta-agl-demo-guides-flounder + git_name: AGL/meta-agl-demo + path: docs/devguides-book.yml +- + id: meta-agl-devel-guides-flounder + git_name: AGL/meta-agl-devel + path: docs/devguides-book.yml +- + id: host-configuration-developer-guides-flounder + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: iotbzh/agl-documentation + git_commit: master + path: host-configuration/docs/devguides-book.yml +- + id: app-templates-guides-flounder + git_name: apps/app-templates + path: docs/devguides-book.yml + dst_prefix: "2_4-Use-app-templates.md" +- + id: xds-docs-guides-flounder + git_name: src/xds/xds-docs + path: docs/devguides-book.yml + dst_prefix: "xds" +- + id: appfw-privileges-management + path: https://iot.bzh/download/public/2016/appfw/03-AGL-AppFW-Privileges-Management.pdf + dst_prefix: iotbzh2016 + name: AppFW - Privileges Management +- + id: app-controller-submodule-guides-flounder + git_name: apps/app-controller-submodule + path: docs/devguides-book.yml + dst_prefix: ctrler +- + id: continuous-integration-ciat + name: Continuous Integration - Automated Testing (CIAT) + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_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_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/devguides/section_master.yml b/content/tocs/devguides/section_master.yml new file mode 100644 index 0000000..5265840 --- /dev/null +++ b/content/tocs/devguides/section_master.yml @@ -0,0 +1,64 @@ +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_name: iotbzh/agl-documentation + path: host-configuration/docs/devguides-book.yml +- + id: cmake-apps-module-guides + git_name: src/cmake-apps-module + path: docs/devguides-book.yml + dst_prefix: "cmakeafbtemplates" +- + id: xds-docs-guides + git_name: src/xds/xds-docs + path: docs/devguides-book.yml + dst_prefix: "xds" +- + id: appfw-privileges-management + path: https://iot.bzh/download/public/2016/appfw/03-AGL-AppFW-Privileges-Management.pdf + dst_prefix: iotbzh2016 + name: AppFW - Privileges Management +- + id: app-controller-submodule-guides + git_name: apps/app-controller-submodule + path: docs/devguides-book.yml + dst_prefix: ctrler +- + id: afb-helpers-function-references + git_name: src/libafb-helpers + path: docs/afb-helpers-book.yml + dst_prefix: afb-helpers +- + id: continuous-integration-ciat + name: Continuous Integration - Automated Testing (CIAT) + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + path: docs/continuous-integration-book.yml + books: + - + id: how-to-write-test-1 + path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf + name: How to write tests (overview slides) + - + id: how-to-write-test-2 + path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/Hands_on_lab_documentation.pdf + name: How to write tests (detailed)
\ No newline at end of file diff --git a/content/tocs/getting_started/section_flounder.yml b/content/tocs/getting_started/section_flounder.yml new file mode 100644 index 0000000..0de0487 --- /dev/null +++ b/content/tocs/getting_started/section_flounder.yml @@ -0,0 +1,18 @@ +url_fetch : "GERRIT_FETCH" + +name: Getting started +template: generated_index.html +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 +- + id: flounder-apps-homescreen + url_fetch: GERRIT_FETCH + git_name: apps/homescreen + dst_prefix: homescreen + path: homescreen/docs/homescreen-book.yml 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/getting_started/section_master.yml b/content/tocs/getting_started/section_master.yml index b6e663c..4777c8d 100644 --- a/content/tocs/getting_started/section_master.yml +++ b/content/tocs/getting_started/section_master.yml @@ -1,16 +1,17 @@ -url_fetch : "AGL_GITHUB_FETCH" -url_edit : "AGL_GITHUB_EDIT" -git_commit : "AGL_GITHUB_BRANCH" +url_fetch : "GERRIT_FETCH" 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 + 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: homescreen - url_fetch : "https://git.automotivelinux.org/apps/homescreen/plain/homescreen/docs/homescreen-book.yml?h=sandbox/benierc/newdocs" + 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_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 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/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 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/howto/section_master.yml b/content/tocs/howto/section_master.yml new file mode 100644 index 0000000..ba3d899 --- /dev/null +++ b/content/tocs/howto/section_master.yml @@ -0,0 +1,12 @@ +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 + 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 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 diff --git a/site/_includes/header.html b/site/_includes/header.html index 6828472..3450e72 100644 --- a/site/_includes/header.html +++ b/site/_includes/header.html @@ -1,3 +1,15 @@ +{% if include.language == "" or include.language == nil %} + {% assign LANGUAGE = "en" %} +{% else %} + {% assign LANGUAGE = include.language %} +{% endif %} +{% if include.version == "" or include.version == nil %} + {% assign VERSION = site.default_linked_docs_version %} +{% else %} + {% assign VERSION = include.version %} +{% endif %} +<!-- LANGUAGE: {{LANGUAGE}} {{include.language}} --> +<!-- VERSION: {{VERSION}} {{include.version}}--> <header> <a class="scroll-point pt-top" name="top"></a> <nav class="navbar navbar-inverse navbar-fixed-top"> @@ -15,23 +27,31 @@ <div class="nav_bar_left"> <ul class="nav navbar-nav"> <li {% if page.specs_tab %}class="active"{% endif %}> - <a href="{{ site.docsurl }}/getting_started/en/{{ site.default_linked_docs_version }}/">Getting Started</a> + <a href="{{ site.docsurl }}/{{LANGUAGE}}/{{VERSION}}/getting_started/">Getting Started</a> </li> - + <li {% if page.specs_tab %}class="active"{% endif %}> - <a href="{{ site.docsurl }}/architecture/en/{{ site.default_linked_docs_version }}/">Architecture Guides</a> + <a href="{{ site.docsurl }}/{{LANGUAGE}}/{{VERSION}}/architecture/">Architecture Guides</a> </li> <li {% if page.appfw_tab %}class="active"{% endif %}> - <a href="{{ site.docsurl }}/hardware/en/{{ site.default_linked_docs_version }}/">Hardware Support</a> + <a href="{{ site.docsurl }}/{{LANGUAGE}}/{{VERSION}}//hardware/">Hardware Support</a> </li> <li {% if page.specs_tab %}class="active"{% endif %}> - <a href="{{ site.docsurl }}/devguides/en/{{ site.default_linked_docs_version }}/">Developer Guides</a> + <a href="{{ site.docsurl }}/{{LANGUAGE}}/{{VERSION}}/devguides/">Developer Guides</a> + </li> + + <li {% if page.appfw_tab %}class="active"{% endif %}> + <a href="{{ site.docsurl }}/{{LANGUAGE}}/{{VERSION}}/apis_services/">APIs & Services</a> </li> - + + <li {% if page.appfw_tab %}class="active"{% endif %}> + <a href="{{ site.docsurl }}/{{LANGUAGE}}/{{VERSION}}/howto/">How To</a> + </li> + <li {% if page.appfw_tab %}class="active"{% endif %}> - <a href="{{ site.docsurl }}/apis_services/en/{{ site.default_linked_docs_version }}/">APIs & Services</a> + <a href="{{ site.docsurl }}/{{LANGUAGE}}/{{VERSION}}/reference/">Reference</a> </li> </ul> </div> diff --git a/site/_layouts/doc.html b/site/_layouts/doc.html index 21f54ff..61ffdf0 100644 --- a/site/_layouts/doc.html +++ b/site/_layouts/doc.html @@ -11,8 +11,6 @@ scripts: - process-uml.js --- -{% include header.html %} - {% comment %} set some constants {% endcomment %} @@ -21,11 +19,20 @@ set some constants {% assign TOCSDIR = site.data.tocs %} {% assign TOCFILE = TOCSDIR[page.tocdir][page.tocfile] %} -{% capture VERSION_ROOT %}{{DOCSDIR}}/{{page.tocdir}}/{{ page.language }}/{{ page.version }}/{% endcapture %} -{% capture LANGUAGE_ROOT %}{{DOCSDIR}}/{{page.tocdir}}/{{ page.language }}/{% endcapture %} +{% capture VERSION_ROOT %}{{DOCSDIR}}/{{ page.language }}/{{ page.version }}/{{page.tocdir}}/{% endcapture %} +{% capture VERSION_URL %}{{DOCSDIR}}/{{ page.language }}/{{ page.version }}/{% endcapture %} +{% capture LANGUAGE_ROOT %}{{DOCSDIR}}/{{ page.language }}/{% endcapture %} -{% assign MY_ENTRY = page.url | replace: VERSION_ROOT,"" %} +{% assign MY_ENTRY = page.url | replace: VERSION_ROOT,"" %} {% assign my_entry_parts = MY_ENTRY | split: "/" %} +<!-- + LANGUAGE_ROOT {{ LANGUAGE_ROOT }} + VERSION_ROOT {{VERSION_ROOT}} + DOCSDIR {{DOCSDIR}} + page.language {{page.language}} +--> + +{% include header.html version=page.version language=page.language %} <div class="docs container"> @@ -196,13 +203,14 @@ set some constants layouts change from version to version {% endcomment %} {% capture other_version_root %}/docs/{{ page.language }}/{{ other_version_string }}/{% endcapture %} - {% assign other_version_url = page.url | replace:VERSION_ROOT,other_version_root %} + {% assign other_version_url = page.url | replace:VERSION_URL,other_version_root %} + {% comment %} {% unless ALL_PAGES contains other_version_url %} {% assign other_version_url = other_version_root %} {% endunless %} - - <a href="{{ site.docsurl }}{{ other_version_url }}" class="{% unless ALL_PAGES contains other_version_url %}missing-page{% endunless %}"> + {% endcomment %} + <a href="{{ site.baseurl }}{{ other_version_url }}" class="{% unless ALL_PAGES contains other_version_url %}missing-page{% endunless %}"> {% if page.version == other_version %} <span class="selected"> {{ version_entry_string }} diff --git a/site/_layouts/howto-en.html b/site/_layouts/howto-en.html new file mode 100644 index 0000000..1b459f8 --- /dev/null +++ b/site/_layouts/howto-en.html @@ -0,0 +1,15 @@ +--- +layout: umldoc +outdated_text: "This version of the documentation is outdated!" +in_development_text: "This version of the documentation is under development!" +click_here_text: "Click here for the latest released version." +toc_text: "Table of Contents" +latest_text: "Latest" +visit_github_text: "Other versions are on GitHub." +plugin_version_text: "This documentation describes this plugin at version" +edit_text: "Edit" +edit_source_text: "Edit Source on GitHub" +edit_translation_text: "Edit Translation on Crowdin" +--- + +{{ content }} diff --git a/site/_layouts/reference-en.html b/site/_layouts/reference-en.html new file mode 100644 index 0000000..1b459f8 --- /dev/null +++ b/site/_layouts/reference-en.html @@ -0,0 +1,15 @@ +--- +layout: umldoc +outdated_text: "This version of the documentation is outdated!" +in_development_text: "This version of the documentation is under development!" +click_here_text: "Click here for the latest released version." +toc_text: "Table of Contents" +latest_text: "Latest" +visit_github_text: "Other versions are on GitHub." +plugin_version_text: "This documentation describes this plugin at version" +edit_text: "Edit" +edit_source_text: "Edit Source on GitHub" +edit_translation_text: "Edit Translation on Crowdin" +--- + +{{ content }} diff --git a/site/docs/docsearch.html b/site/docs/docsearch.html index 0e3c7b0..7e671a5 100644 --- a/site/docs/docsearch.html +++ b/site/docs/docsearch.html @@ -5,11 +5,13 @@ <html lang="{% if page.language %}{{ page.language }}{% else %}{{ site.language }}{% endif %}"> {% include head.html %} <body> - <h3><a href="{{ site.docsurl }}/getting_started/en/{{ site.default_linked_docs_version }}/">Getting started</a></h3> - <h3><a href="{{ site.docsurl }}/hardware/en/{{ site.default_linked_docs_version }}/">Hardware Support</a></h3> - <h3><a href="{{ site.docsurl }}/architecture/en/{{ site.default_linked_docs_version }}/">Architecture Guides</a></h3> - <h3><a href="{{ site.docsurl }}/devguides/en/{{ site.default_linked_docs_version }}/">Developer Guides</a></h3> - <h3><a href="{{ site.docsurl }}/apis_services/en/{{ site.default_linked_docs_version }}/">APIs & Services</a></h3> + <h3><a href="{{ site.docsurl }}/en/{{ site.default_linked_docs_version }}/getting_started/">Getting started</a></h3> + <h3><a href="{{ site.docsurl }}/en/{{ site.default_linked_docs_version }}/hardware/">Hardware Support</a></h3> + <h3><a href="{{ site.docsurl }}/en/{{ site.default_linked_docs_version }}/architecture/">Architecture Guides</a></h3> + <h3><a href="{{ site.docsurl }}/en/{{ site.default_linked_docs_version }}/devguides/">Developer Guides</a></h3> + <h3><a href="{{ site.docsurl }}/en/{{ site.default_linked_docs_version }}/apis_services/">APIs & Services</a></h3> + <h3><a href="{{ site.docsurl }}/en/{{ site.default_linked_docs_version }}/howto/">How To</a></h3> + <h3><a href="{{ site.docsurl }}/en/{{ site.default_linked_docs_version }}/reference/">Reference</a></h3> {% include algolia.html %} </body> </html> diff --git a/site/index.html b/site/index.html index cb4c0a4..efa2d4e 100644 --- a/site/index.html +++ b/site/index.html @@ -20,7 +20,7 @@ change_frequency: monthly <p>Multiple platforms on <em>a common code base</em></p> <p>Free and <em>open source</em></p> <div class="hero_buttons"> - <a href="{{ site.baseurl }}/docs/getting_started/en/{{ site.default_linked_docs_version }}" class="col-xs-12 col-sm-5 btn btn-lg btn-primary"> + <a href="{{ site.baseurl }}/docs/en/{{ site.default_linked_docs_version }}/getting_started" class="col-xs-12 col-sm-5 btn btn-lg btn-primary"> Get Started </a> <a href="{{ site.baseurl }}/contribute" class="col-xs-12 col-sm-5 btn btn-lg btn-primary"> @@ -67,7 +67,7 @@ change_frequency: monthly <div class="col-md-12 text-center"> <h1>Supported Platforms</h1> <h2>See a list of - <a href="{{ site.baseurl }}/docs/hardware/en/{{ site.default_linked_docs_version }}/index.html">features supported</a> in each platform</h2> + <a href="{{ site.baseurl }}/docs/en/{{ site.default_linked_docs_version }}/hardware/index.html">features supported</a> in each platform</h2> <p> Automotive Grade Linux (AGL) is a Linux Foundation project dedicated to creating open source software solutions for automotive applications. Although the initial target for AGL is In-Vehicle-Infotainment (IVI) systems, additional use cases such as instrument clusters and telematics systems will eventually be supported. AGL has participants from the Automotive, Communications, and Semiconductor Industries and welcomes contributions from individual developers. </p> |