aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorClément Bénier <clement.benier@iot.bzh>2019-03-29 16:56:08 +0100
committerClément Bénier <clement.benier@iot.bzh>2019-03-29 17:04:38 +0100
commita734c2f254fe669c20a8fc62a8c4497a5edf708a (patch)
treea5fb597c483c9fc4242f339382921396c0cca437
parentddb7b9f1ac7e5b74d4f11f4149456b627b6af439 (diff)
parent657afcf4e2bb93255d722b8019a2a352ffc534d1 (diff)
Merge remote-tracking branch 'origin/master-next'
-rw-r--r--.gitignore4
-rw-r--r--Makefile29
-rw-r--r--conf/AppDefaults.js1
-rw-r--r--conf/_config.yml2
-rw-r--r--conf/_dev.yml2
-rw-r--r--content/tocs/apis_services/fetched_files.yml418
-rw-r--r--content/tocs/apis_services/section_flounder.yml111
-rw-r--r--content/tocs/apis_services/section_guppy.yml110
-rw-r--r--content/tocs/apis_services/section_master.yml108
-rw-r--r--content/tocs/apis_services/toc_dev_en.yml5
-rw-r--r--content/tocs/architecture/fetched_files.yml140
-rw-r--r--content/tocs/architecture/section_flounder.yml18
-rw-r--r--content/tocs/architecture/section_guppy.yml18
-rw-r--r--content/tocs/architecture/section_master.yml18
-rw-r--r--content/tocs/devguides/fetched_files.yml195
-rw-r--r--content/tocs/devguides/section_flounder.yml66
-rw-r--r--content/tocs/devguides/section_guppy.yml68
-rw-r--r--content/tocs/devguides/section_master.yml65
-rw-r--r--content/tocs/devguides/toc_dev_en.yml2
-rw-r--r--content/tocs/getting_started/fetched_files.yml92
-rw-r--r--content/tocs/getting_started/section_flounder.yml17
-rw-r--r--content/tocs/getting_started/section_guppy.yml17
-rw-r--r--content/tocs/getting_started/section_master.yml17
-rw-r--r--content/tocs/getting_started/toc_dev_en.yml47
-rw-r--r--content/tocs/hardware/fetched_files.yml56
-rw-r--r--content/tocs/hardware/section_flounder.yml11
-rw-r--r--content/tocs/hardware/section_guppy.yml11
-rw-r--r--content/tocs/hardware/section_master.yml11
-rw-r--r--content/tocs/howto/section_guppy.yml12
-rw-r--r--content/tocs/howto/section_master.yml12
-rw-r--r--content/tocs/reference/section_guppy.yml4
-rw-r--r--content/tocs/reference/section_master.yml4
-rw-r--r--content/tocs_flounder/apis_services/fetched_files.yml409
-rw-r--r--content/tocs_flounder/architecture/fetched_files.yml140
-rw-r--r--content/tocs_flounder/devguides/fetched_files.yml168
-rw-r--r--content/tocs_flounder/getting_started/fetched_files.yml92
-rw-r--r--content/tocs_flounder/hardware/fetched_files.yml56
-rw-r--r--content/tocs_guppy/apis_services/fetched_files.yml418
-rw-r--r--content/tocs_guppy/architecture/fetched_files.yml140
-rw-r--r--content/tocs_guppy/devguides/fetched_files.yml195
-rw-r--r--content/tocs_guppy/getting_started/fetched_files.yml92
-rw-r--r--content/tocs_guppy/hardware/fetched_files.yml56
-rwxr-xr-xsetupdocs.sh13
-rw-r--r--site/.htaccess8
-rw-r--r--site/_data/redirects.yml1
-rw-r--r--site/_includes/header.html34
-rw-r--r--site/_layouts/doc.html66
-rw-r--r--site/_layouts/howto-en.html15
-rw-r--r--site/_layouts/reference-en.html15
-rw-r--r--site/docs/docsearch.html12
-rw-r--r--site/index.html6
51 files changed, 882 insertions, 2745 deletions
diff --git a/.gitignore b/.gitignore
index 8f6dcc3..3f9e1ad 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,6 +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/Makefile b/Makefile
index 8892612..26a6688 100644
--- a/Makefile
+++ b/Makefile
@@ -8,13 +8,19 @@ LOCALFETCH=.LocalFetch.ts
all: help
help:
- @echo "Usage:"
- @echo "- make clean: clean all generated files"
- @echo "- make fetch: fetch the site if necessary"
- @echo "- make localFetch: fetch the site if necessary but use local file."
- @echo "- make build: build the site"
- @echo "- make push: push the built site"
- @echo "- make serve: serve the site"
+ @echo -e "Usage:"
+ @echo -e "- make clean: clean all generated files"
+ @echo -e "- make fetch VERSIONS=[VERSION,...] SECTIONS=[SECTION,...]: fetch the site if necessary "
+ @echo -e "- make localFetch VERSIONS=[VERSION,...] SECTIONS=[SECTION,...]: fetch the site if necessary but use local file."
+ @echo -e "- make build VERSIONS=[VERSION,...] SECTIONS=[SECTION,...]: build the site"
+ @echo -e "- make push VERSIONS=[VERSION,...] SECTIONS=[SECTION,...]: push the built site"
+ @echo -e "- make serve VERSIONS=[VERSION,...] SECTIONS=[SECTION,...]: serve the site"
+ @echo -e "- make linkchecker: check link in the local site, PORT=[default:4000]"
+ @echo -e
+ @echo -e "VERSIONS="
+ @echo -e "\t represents the desired versions, separated with ,"
+ @echo -e "SECTIONS="
+ @echo -e "\t represents the desired sections, separated with ,"
.PHONY: clean
clean:
@@ -28,7 +34,7 @@ $(LOCALFETCH): $(wildcard content/toc/*/fetched_files.yml)
touch $@
$(FETCHTS): $(wildcard content/toc/*/fetched_files.yml)
- $(DOCBUILD) $(VERBOSE) $(LOCAL_FETCHTS) --fetch --force
+ $(DOCBUILD) $(VERBOSE) $(LOCAL_FETCHTS) --fetch --force --versions=$(VERSIONS) --sections=$(SECTIONS)
touch $@
.PHONY: fetch
@@ -51,3 +57,10 @@ push: $(FETCHTS)
serve: $(FETCHTS)
$(DOCBUILD) $(VERBOSE) --build --serve
+.PHONY: linkchecker
+linkchecker: $(FETCHS)
+ @which linkchecker &> /dev/null || { echo "No linkchecker found, please install linkchecker"; exit -1; }
+ @curl http://localhost:4000 &> /dev/null || { echo "No localhost:4000 found: Please run make serve before checking localsite"; exit -1; }
+ linkchecker http://localhost:4000
+
+
diff --git a/conf/AppDefaults.js b/conf/AppDefaults.js
index 6a9e213..03f0896 100644
--- a/conf/AppDefaults.js
+++ b/conf/AppDefaults.js
@@ -38,6 +38,7 @@ config = {
// alternate url using cgit
GERRIT_FETCH: "https://git.automotivelinux.org/%repo%/plain/%source%?h=%commit%",
AGL_GERRIT_BRANCH : "master",
+ AGL_GITHUB_BRANCH : "master-next",
LAST: undefined
};
diff --git a/conf/_config.yml b/conf/_config.yml
index 9fec3d5..b93c6fb 100644
--- a/conf/_config.yml
+++ b/conf/_config.yml
@@ -22,7 +22,7 @@ excerpt_separator: <!--more-->
# the version to which /latest/ points
# NOTE:
# this value gets overwritten in _version.yml, which is a generated file
-latest_docs_version: dev # overloaded by AppDefaults.js
+latest_docs_version: master # overloaded by AppDefaults.js
# the docs version that is shown by default when clicking on docs links on the site
default_linked_docs_version: latest
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/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml
deleted file mode 100644
index e897661..0000000
--- a/content/tocs/apis_services/fetched_files.yml
+++ /dev/null
@@ -1,418 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-url_fetch: GERRIT_FETCH
-git_commit: AGL_GERRIT_BRANCH
-
-repositories:
--
- git_name: src/app-framework-main
- src_prefix: docs
- dst_prefix: af-main
- documents:
- - source: 0-introduction.md
- label: Introduction
- - 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/section_flounder.yml b/content/tocs/apis_services/section_flounder.yml
new file mode 100644
index 0000000..993d60f
--- /dev/null
+++ b/content/tocs/apis_services/section_flounder.yml
@@ -0,0 +1,111 @@
+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
+ 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_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
+ 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-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-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
+ brotherBooks:
+ - 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..b75bbac
--- /dev/null
+++ b/content/tocs/apis_services/section_guppy.yml
@@ -0,0 +1,110 @@
+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_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_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
+ 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: 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: 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
new file mode 100644
index 0000000..e3d087d
--- /dev/null
+++ b/content/tocs/apis_services/section_master.yml
@@ -0,0 +1,108 @@
+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_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
+ 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: 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: 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/toc_dev_en.yml b/content/tocs/apis_services/toc_dev_en.yml
index f793a51..023e699 100644
--- a/content/tocs/apis_services/toc_dev_en.yml
+++ b/content/tocs/apis_services/toc_dev_en.yml
@@ -39,6 +39,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:
- url: reference/af-main/0-introduction.html
diff --git a/content/tocs/architecture/fetched_files.yml b/content/tocs/architecture/fetched_files.yml
deleted file mode 100644
index b57d5d2..0000000
--- a/content/tocs/architecture/fetched_files.yml
+++ /dev/null
@@ -1,140 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-#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/section_flounder.yml b/content/tocs/architecture/section_flounder.yml
new file mode 100644
index 0000000..66b4fb8
--- /dev/null
+++ b/content/tocs/architecture/section_flounder.yml
@@ -0,0 +1,18 @@
+url_fetch : "GERRIT_FETCH"
+# FIXME: restore line below to switch back on master:
+#git_commit : "AGL_GERRIT_BRANCH"
+
+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..65246cd
--- /dev/null
+++ b/content/tocs/architecture/section_guppy.yml
@@ -0,0 +1,18 @@
+url_fetch : "GERRIT_FETCH"
+# FIXME: restore line below to switch back on master:
+#git_commit : "AGL_GERRIT_BRANCH"
+
+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..65246cd
--- /dev/null
+++ b/content/tocs/architecture/section_master.yml
@@ -0,0 +1,18 @@
+url_fetch : "GERRIT_FETCH"
+# FIXME: restore line below to switch back on master:
+#git_commit : "AGL_GERRIT_BRANCH"
+
+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/fetched_files.yml b/content/tocs/devguides/fetched_files.yml
deleted file mode 100644
index 1df36b1..0000000
--- a/content/tocs/devguides/fetched_files.yml
+++ /dev/null
@@ -1,195 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-url_fetch: GERRIT_FETCH
-git_commit: AGL_GERRIT_BRANCH
-
-repositories:
--
- git_name: AGL/meta-agl
- documents:
- - source: README-AGL.md
- destination: AGL.md
- label: AGL Overview
- - source: README.md
- destination: meta-agl.md
- label: meta-agl
--
- git_name: AGL/meta-agl-demo
- documents:
- - source: README.md
- destination: meta-agl-demo.md
- label: meta-agl-demo
--
- git_name: AGL/meta-agl-devel
- documents:
- - source: README.md
- destination: meta-agl-devel.md
- label: meta-agl-devel
--
- url_fetch: https://iot.bzh/download/public/2016/%source%
- dst_prefix: iotbzh2016
- documents:
- - source: appfw/03-AGL-AppFW-Privileges-Management.pdf
--
- url_fetch: "GITHUB_FETCH"
- git_name: iotbzh/agl-documentation
- git_commit: "master"
- documents:
- - source: host-configuration/docs/0_Abstract.md
- - source: host-configuration/docs/1_Prerequisites.md
- - source: host-configuration/docs/2_AGL_Application_Framework.md
- - source: host-configuration/docs/3_Binding_Build_Example.md
- - source: host-configuration/docs/4_AGL_XDS.md
- - source: host-configuration/docs/5_Candevstudio.md
--
- git_name: src/cmake-apps-module
- src_prefix: "docs/dev_guide"
- dst_prefix: "cmakeafbtemplates"
- documents:
- - source: 0_Abstract.md
- - source: 1_Quickstart.md
- - source: 2_project_architecture.md
- - source: 3_advanced_usage.md
- - source: 4_advanced_customization.md
- - source: 5_autobuild.md
--
- git_name: src/xds/xds-docs
- src_prefix: "docs"
- dst_prefix: "xds"
- documents:
- - source: part-1/0_Abstract.md
- - source: part-1/1_install-xds-server.md
- - source: part-1/1-1_install-xds-server-docker.md
- - source: part-1/1-2_install-xds-server-vm.md
- - source: part-1/1-3_install-xds-server-native.md
- - source: part-1/2_install-client.md
- - source: part-1/3_install-sdks.md
- - source: part-1/4-1_build-first-app-setup.md
- - source: part-1/4-2_build-first-app-cmd.md
- - source: part-1/4-3_build-first-app-dashboard.md
- - source: part-1/4-4_build-first-app-ide.md
- - source: part-1/4_build-first-app.md
- - source: part-1/5-1_debug-first-app-config.md
- - source: part-1/5-2_debug-first-app-cmd.md
- - source: part-1/5-3_debug-first-app-ide.md
- - source: part-1/5_debug-first-app.md
- - source: part-1/pictures/nb_new-project-1.png
- - source: part-1/pictures/nb_new-project-2.png
- - source: part-1/pictures/nb_new-project-3.png
- - source: part-1/pictures/nb_new-project-4.png
- - source: part-1/pictures/nb_new-project-5.png
- - source: part-1/pictures/nb_newtool.png
- - source: part-1/pictures/nb_project_debug-1.png
- - source: part-1/pictures/nb_xds_options.png
- - source: part-1/pictures/xds-block-chain.png
- - source: part-1/pictures/xds-block-diagram.png
- - source: part-1/pictures/xds-conf.png
- - source: part-1/pictures/xds-dashboard-icon-1.png
- - source: part-1/pictures/xds-dashboard-icon-2.png
- - source: part-1/pictures/xds-dashboard-icon-3.png
- - source: part-1/pictures/xds-dashboard-prj-1.png
- - source: part-1/pictures/xds-dashboard-prj-2.png
- - source: part-1/pictures/xds-dashboard-sdks-install.png
- - source: part-1/pictures/xds-dashboard-sdks-mgt.png
- - source: part-2/0_Abstract.md
- - source: part-2/1_Prerequisites.md
- - source: part-2/1_xds-server/0_abstract.md
- - source: part-2/1_xds-server/1_build.md
- - source: part-2/1_xds-server/2_config.md
- - source: part-2/1_xds-server/3_how-to-run.md
- - source: part-2/1_xds-server/4_debug.md
- - source: part-2/1_xds-server/5_test.md
- - source: part-2/2_xds-agent/0_abstract.md
- - source: part-2/2_xds-agent/1_build.md
- - source: part-2/2_xds-agent/2_config.md
- - source: part-2/2_xds-agent/3_start.md
- - source: part-2/2_xds-agent/4_debug.md
- - source: part-2/3_xds-cli/0_abstract.md
- - source: part-2/3_xds-cli/1_build.md
- - source: part-2/3_xds-cli/2_config.md
- - source: part-2/3_xds-cli/3_commands.md
- - source: part-2/3_xds-cli/4_debug.md
- - source: part-2/4_xds-gdb/0_abstract.md
- - source: part-2/4_xds-gdb/1_build.md
- - source: part-2/4_xds-gdb/2_config.md
- - source: part-2/4_xds-gdb/3_debug.md
-
--
- url_fetch: GITHUB_FETCH
- url_edit: GITHUB_EDIT
- git_name: baylibre/agl-docs-baylibre
- git_commit: master
- documents:
- - source: CIAT/training/How_to_write_your_own_tests_for_AGL.pdf
- - source: CIAT/training/Hands_on_lab_documentation.pdf
--
- git_name: src/libappcontroller
- src_prefix: docs
- dst_prefix: ctrler
- documents:
- - source: Usage.md
- label: Usage
- - source: configSample.md
- label: Configuration Sample
- - source: controller.md
- label: Installation
- - source: controllerConfig.md
- label: Binding Configuration
--
- git_name: src/libafb-helpers
- src_prefix: docs
- dst_prefix: afb-helpers
- documents:
- - source: usage.md
- label: Usage
- - source: afb-timer.md
- label: AFB Timer
- - source: curl-wrap.md
- label: CURL wrapper
- - source: escape.md
- label: URL escaping
- - source: filescan-utils.md
- label: Filescan Utils
- - source: qafbwebsocketclient.md
- label: Qt AFB Websocket client
- - source: json.md
- label: JSON library for modern C++
- - source: wrap-json.md
- label: C JSON Wrapper
diff --git a/content/tocs/devguides/section_flounder.yml b/content/tocs/devguides/section_flounder.yml
new file mode 100644
index 0000000..a18fb37
--- /dev/null
+++ b/content/tocs/devguides/section_flounder.yml
@@ -0,0 +1,66 @@
+url_fetch : "GERRIT_FETCH"
+git_commit : "flounder"
+
+name: Developers Guides
+template: generated_index.html
+books:
+-
+ id: meta-agl-developer-guides-flounder
+ git_name: AGL/meta-agl
+ path: docs/devguides-book.yml
+ brotherBooks:
+ -
+ id: meta-agl-demo-guides-flounder
+ git_name: AGL/meta-agl-demo
+ path: docs/devguides-book.yml
+ -
+ id: meta-agl-devel-guides-flounder
+ git_name: AGL/meta-agl-devel
+ path: docs/devguides-book.yml
+-
+ id: host-configuration-developer-guides-flounder
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_name: iotbzh/agl-documentation
+ git_commit: master
+ path: host-configuration/docs/devguides-book.yml
+-
+ id: app-templates-guides-flounder
+ git_name: apps/app-templates
+ path: docs/devguides-book.yml
+ dst_prefix: "2_4-Use-app-templates.md"
+-
+ id: xds-docs-guides-flounder
+ git_name: src/xds/xds-docs
+ path: docs/devguides-book.yml
+ dst_prefix: "xds"
+-
+ id: appfw-privileges-management
+ path: https://iot.bzh/download/public/2016/appfw/03-AGL-AppFW-Privileges-Management.pdf
+ dst_prefix: iotbzh2016
+ name: AppFW - Privileges Management
+-
+ id: app-controller-submodule-guides-flounder
+ git_name: apps/app-controller-submodule
+ path: docs/devguides-book.yml
+ dst_prefix: ctrler
+-
+ id: continuous-integration-ciat
+ name: Continuous Integration - Automated Testing (CIAT)
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/continuous-integration-book.yml
+ books:
+ -
+ id: how-to-write-test-1
+ path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf
+ git_commit: master
+ name: How to write tests (overview slides)
+ -
+ id: how-to-write-test-2
+ path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/Hands_on_lab_documentation.pdf
+ git_commit: master
+ name: How to write tests (detailed)
+
+
diff --git a/content/tocs/devguides/section_guppy.yml b/content/tocs/devguides/section_guppy.yml
new file mode 100644
index 0000000..7408b41
--- /dev/null
+++ b/content/tocs/devguides/section_guppy.yml
@@ -0,0 +1,68 @@
+url_fetch : "GERRIT_FETCH"
+
+name: Developers Guides
+template: generated_index.html
+books:
+-
+ id: meta-agl-developer-guides
+ git_name: AGL/meta-agl
+ path: docs/devguides-book.yml
+ brotherBooks:
+ -
+ id: meta-agl-demo-guides
+ git_name: AGL/meta-agl-demo
+ path: docs/devguides-book.yml
+ -
+ id: meta-agl-devel-guides
+ git_name: AGL/meta-agl-devel
+ path: docs/devguides-book.yml
+-
+ id: host-configuration-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_commit: master
+ git_name: iotbzh/agl-documentation
+ path: host-configuration/docs/devguides-book.yml
+-
+ id: cmake-apps-module-guides
+ git_name: src/cmake-apps-module
+ path: docs/devguides-book.yml
+ dst_prefix: "cmakeafbtemplates"
+-
+ id: xds-docs-guides
+ git_name: src/xds/xds-docs
+ path: docs/devguides-book.yml
+ dst_prefix: "xds"
+-
+ id: appfw-privileges-management
+ path: https://iot.bzh/download/public/2016/appfw/03-AGL-AppFW-Privileges-Management.pdf
+ dst_prefix: iotbzh2016
+ name: AppFW - Privileges Management
+-
+ id: app-controller-submodule-guides
+ git_name: apps/app-controller-submodule
+ path: docs/devguides-book.yml
+ dst_prefix: ctrler
+-
+ id: afb-helpers-function-references
+ git_name: src/libafb-helpers
+ path: docs/afb-helpers-book.yml
+ dst_prefix: afb-helpers
+-
+ id: continuous-integration-ciat
+ name: Continuous Integration - Automated Testing (CIAT)
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/continuous-integration-book.yml
+ books:
+ -
+ id: how-to-write-test-1
+ git_commit: master
+ path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf
+ name: How to write tests (overview slides)
+ -
+ id: how-to-write-test-2
+ git_commit: master
+ path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/Hands_on_lab_documentation.pdf
+ name: How to write tests (detailed)
diff --git a/content/tocs/devguides/section_master.yml b/content/tocs/devguides/section_master.yml
new file mode 100644
index 0000000..cfe3089
--- /dev/null
+++ b/content/tocs/devguides/section_master.yml
@@ -0,0 +1,65 @@
+url_fetch : "GERRIT_FETCH"
+
+name: Developers Guides
+template: generated_index.html
+books:
+-
+ id: meta-agl-developer-guides
+ git_name: AGL/meta-agl
+ path: docs/devguides-book.yml
+ brotherBooks:
+ -
+ id: meta-agl-demo-guides
+ git_name: AGL/meta-agl-demo
+ path: docs/devguides-book.yml
+ -
+ id: meta-agl-devel-guides
+ git_name: AGL/meta-agl-devel
+ path: docs/devguides-book.yml
+-
+ id: host-configuration-developer-guides
+ url_fetch: GITHUB_FETCH
+ url_edit: GITHUB_EDIT
+ git_name: iotbzh/agl-documentation
+ path: host-configuration/docs/devguides-book.yml
+-
+ id: cmake-apps-module-guides
+ git_name: src/cmake-apps-module
+ path: docs/devguides-book.yml
+ dst_prefix: "cmakeafbtemplates"
+-
+ id: xds-docs-guides
+ git_name: src/xds/xds-docs
+ path: docs/devguides-book.yml
+ dst_prefix: "xds"
+-
+ id: appfw-privileges-management
+ path: https://iot.bzh/download/public/2016/appfw/03-AGL-AppFW-Privileges-Management.pdf
+ dst_prefix: iotbzh2016
+ name: AppFW - Privileges Management
+-
+ id: app-controller-submodule-guides
+ git_name: apps/app-controller-submodule
+ path: docs/devguides-book.yml
+ dst_prefix: ctrler
+-
+ id: afb-helpers-function-references
+ git_name: src/libafb-helpers
+ path: docs/afb-helpers-book.yml
+ dst_prefix: afb-helpers
+-
+ id: continuous-integration-ciat
+ name: Continuous Integration - Automated Testing (CIAT)
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: automotive-grade-linux/docs-sources
+ path: docs/continuous-integration-book.yml
+ books:
+ -
+ id: how-to-write-test-1
+ path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf
+ name: How to write tests (overview slides)
+ -
+ id: how-to-write-test-2
+ path: https://github.com/BayLibre/agl-docs-baylibre/blob/%commit%/CIAT/training/Hands_on_lab_documentation.pdf
+ name: How to write tests (detailed)
diff --git a/content/tocs/devguides/toc_dev_en.yml b/content/tocs/devguides/toc_dev_en.yml
index 3c99142..551ae12 100644
--- a/content/tocs/devguides/toc_dev_en.yml
+++ b/content/tocs/devguides/toc_dev_en.yml
@@ -39,7 +39,7 @@ name: Developer Guides
template: generated_index.html
children:
-
- name: Yocto layers
+ name: AGL layers
children:
- url: reference/AGL.html
- url: reference/meta-agl.html
diff --git a/content/tocs/getting_started/fetched_files.yml b/content/tocs/getting_started/fetched_files.yml
deleted file mode 100644
index ba1fafe..0000000
--- a/content/tocs/getting_started/fetched_files.yml
+++ /dev/null
@@ -1,92 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-#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: source-code.md
- label: Download AGL Source Code
- - source: customize_bitbake_conf.md
- label: Customize the AGL build
- - source: machines/intel.md
- label: Build for Intel
- - 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: troubleshooting.md
- label: Generic issues
- - source: footers/intel-footer.md
- label: Intel Boards
- - source: footers/raspberrypi-footer.md
- 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
--
- 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/section_flounder.yml b/content/tocs/getting_started/section_flounder.yml
new file mode 100644
index 0000000..51644bf
--- /dev/null
+++ b/content/tocs/getting_started/section_flounder.yml
@@ -0,0 +1,17 @@
+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_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..4777c8d
--- /dev/null
+++ b/content/tocs/getting_started/section_guppy.yml
@@ -0,0 +1,17 @@
+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_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
new file mode 100644
index 0000000..4777c8d
--- /dev/null
+++ b/content/tocs/getting_started/section_master.yml
@@ -0,0 +1,17 @@
+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_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/toc_dev_en.yml b/content/tocs/getting_started/toc_dev_en.yml
index a534c61..8251337 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: <subdir as defined with FETCH_DIR in conf/AppDefaults.js:
# -
@@ -39,13 +39,21 @@ name: Getting started
template: generated_index.html
children:
-
- name: Getting Started
+ name: Welcome!
+ children:
+ - url: reference/getting-started-welcome.html
+-
+ name: Developing an AGL Image
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
+ - url: reference/machines/renesas.html
- url: reference/machines/raspberrypi.html
-
name: HomeScreen
@@ -55,10 +63,23 @@ children:
name: Troubleshooting
children:
- url: reference/troubleshooting.html
- - url: reference/footers/intel-footer.html
- - url: reference/footers/raspberrypi-footer.html
-
- name: SDK
+ name: Setting Up a Docker Container
children:
- - url: reference/setup-sdk-environment.html
-
+ - url: reference/docker-container-setup.html
+-
+# name: Scott's new section so far
+# children:
+# - url: reference/scott.html
+#-
+ name: Developing an Application
+ children:
+ - url: reference/app-workflow-intro.html
+ - url: reference/app-workflow-image.html
+ - url: reference/app-workflow-sdk.html
+ - url: reference/app-workflow-bootables.html
+ - url: reference/app-workflow-boot.html
+ - url: reference/app-workflow-prep-app.html
+ - url: reference/app-workflow-build-app.html
+ - url: reference/app-workflow-deploy-app.html
+ - url: reference/app-workflow-debug-app.html
diff --git a/content/tocs/hardware/fetched_files.yml b/content/tocs/hardware/fetched_files.yml
deleted file mode 100644
index f1decf7..0000000
--- a/content/tocs/hardware/fetched_files.yml
+++ /dev/null
@@ -1,56 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-#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/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..ba3d899
--- /dev/null
+++ b/content/tocs/howto/section_guppy.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/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/content/tocs_flounder/apis_services/fetched_files.yml b/content/tocs_flounder/apis_services/fetched_files.yml
deleted file mode 100644
index f68a7fd..0000000
--- a/content/tocs_flounder/apis_services/fetched_files.yml
+++ /dev/null
@@ -1,409 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-url_fetch: GERRIT_FETCH
-git_commit: AGL_GERRIT_BRANCH
-
-repositories:
--
- git_name: src/app-framework-main
- src_prefix: docs
- dst_prefix: af-main
- documents:
- - source: 0-introduction.md
- label: Introduction
- - 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
- git_commit: master
- 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/initialize-registercallback.svg
- - source: parts/initialize-set-event-handler.svg
- - source: parts/initialize.svg
- - source: parts/on_screen_message.svg
- - source: parts/software-stack.png
- - source: parts/tap_shortcut.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
--
- 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_flounder/architecture/fetched_files.yml b/content/tocs_flounder/architecture/fetched_files.yml
deleted file mode 100644
index b57d5d2..0000000
--- a/content/tocs_flounder/architecture/fetched_files.yml
+++ /dev/null
@@ -1,140 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-#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_flounder/devguides/fetched_files.yml b/content/tocs_flounder/devguides/fetched_files.yml
deleted file mode 100644
index a616500..0000000
--- a/content/tocs_flounder/devguides/fetched_files.yml
+++ /dev/null
@@ -1,168 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-url_fetch: GERRIT_FETCH
-git_commit: AGL_GERRIT_BRANCH
-
-repositories:
--
- git_name: AGL/meta-agl
- documents:
- - source: README-AGL.md
- destination: AGL.md
- label: AGL Overview
- - source: README.md
- destination: meta-agl.md
- label: meta-agl
--
- git_name: AGL/meta-agl-demo
- documents:
- - source: README.md
- destination: meta-agl-demo.md
- label: meta-agl-demo
--
- git_name: AGL/meta-agl-devel
- documents:
- - source: README.md
- destination: meta-agl-devel.md
- label: meta-agl-devel
--
- url_fetch: https://iot.bzh/download/public/2016/%source%
- dst_prefix: iotbzh2016
- documents:
- - source: appfw/03-AGL-AppFW-Privileges-Management.pdf
--
- url_fetch: "GITHUB_FETCH"
- git_name: iotbzh/agl-documentation
- 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: apps/app-templates
- dst_prefix: "app-templates"
- documents:
- - source: README.md
- destination: docs/0-App-templates-usage.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_flounder/getting_started/fetched_files.yml b/content/tocs_flounder/getting_started/fetched_files.yml
deleted file mode 100644
index ba1fafe..0000000
--- a/content/tocs_flounder/getting_started/fetched_files.yml
+++ /dev/null
@@ -1,92 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-#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: source-code.md
- label: Download AGL Source Code
- - source: customize_bitbake_conf.md
- label: Customize the AGL build
- - source: machines/intel.md
- label: Build for Intel
- - 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: troubleshooting.md
- label: Generic issues
- - source: footers/intel-footer.md
- label: Intel Boards
- - source: footers/raspberrypi-footer.md
- 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
--
- 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_flounder/hardware/fetched_files.yml b/content/tocs_flounder/hardware/fetched_files.yml
deleted file mode 100644
index f1decf7..0000000
--- a/content/tocs_flounder/hardware/fetched_files.yml
+++ /dev/null
@@ -1,56 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-#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_guppy/apis_services/fetched_files.yml b/content/tocs_guppy/apis_services/fetched_files.yml
deleted file mode 100644
index e897661..0000000
--- a/content/tocs_guppy/apis_services/fetched_files.yml
+++ /dev/null
@@ -1,418 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-url_fetch: GERRIT_FETCH
-git_commit: AGL_GERRIT_BRANCH
-
-repositories:
--
- git_name: src/app-framework-main
- src_prefix: docs
- dst_prefix: af-main
- documents:
- - source: 0-introduction.md
- label: Introduction
- - 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_guppy/architecture/fetched_files.yml b/content/tocs_guppy/architecture/fetched_files.yml
deleted file mode 100644
index b57d5d2..0000000
--- a/content/tocs_guppy/architecture/fetched_files.yml
+++ /dev/null
@@ -1,140 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-#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_guppy/devguides/fetched_files.yml b/content/tocs_guppy/devguides/fetched_files.yml
deleted file mode 100644
index 1df36b1..0000000
--- a/content/tocs_guppy/devguides/fetched_files.yml
+++ /dev/null
@@ -1,195 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-url_fetch: GERRIT_FETCH
-git_commit: AGL_GERRIT_BRANCH
-
-repositories:
--
- git_name: AGL/meta-agl
- documents:
- - source: README-AGL.md
- destination: AGL.md
- label: AGL Overview
- - source: README.md
- destination: meta-agl.md
- label: meta-agl
--
- git_name: AGL/meta-agl-demo
- documents:
- - source: README.md
- destination: meta-agl-demo.md
- label: meta-agl-demo
--
- git_name: AGL/meta-agl-devel
- documents:
- - source: README.md
- destination: meta-agl-devel.md
- label: meta-agl-devel
--
- url_fetch: https://iot.bzh/download/public/2016/%source%
- dst_prefix: iotbzh2016
- documents:
- - source: appfw/03-AGL-AppFW-Privileges-Management.pdf
--
- url_fetch: "GITHUB_FETCH"
- git_name: iotbzh/agl-documentation
- git_commit: "master"
- documents:
- - source: host-configuration/docs/0_Abstract.md
- - source: host-configuration/docs/1_Prerequisites.md
- - source: host-configuration/docs/2_AGL_Application_Framework.md
- - source: host-configuration/docs/3_Binding_Build_Example.md
- - source: host-configuration/docs/4_AGL_XDS.md
- - source: host-configuration/docs/5_Candevstudio.md
--
- git_name: src/cmake-apps-module
- src_prefix: "docs/dev_guide"
- dst_prefix: "cmakeafbtemplates"
- documents:
- - source: 0_Abstract.md
- - source: 1_Quickstart.md
- - source: 2_project_architecture.md
- - source: 3_advanced_usage.md
- - source: 4_advanced_customization.md
- - source: 5_autobuild.md
--
- git_name: src/xds/xds-docs
- src_prefix: "docs"
- dst_prefix: "xds"
- documents:
- - source: part-1/0_Abstract.md
- - source: part-1/1_install-xds-server.md
- - source: part-1/1-1_install-xds-server-docker.md
- - source: part-1/1-2_install-xds-server-vm.md
- - source: part-1/1-3_install-xds-server-native.md
- - source: part-1/2_install-client.md
- - source: part-1/3_install-sdks.md
- - source: part-1/4-1_build-first-app-setup.md
- - source: part-1/4-2_build-first-app-cmd.md
- - source: part-1/4-3_build-first-app-dashboard.md
- - source: part-1/4-4_build-first-app-ide.md
- - source: part-1/4_build-first-app.md
- - source: part-1/5-1_debug-first-app-config.md
- - source: part-1/5-2_debug-first-app-cmd.md
- - source: part-1/5-3_debug-first-app-ide.md
- - source: part-1/5_debug-first-app.md
- - source: part-1/pictures/nb_new-project-1.png
- - source: part-1/pictures/nb_new-project-2.png
- - source: part-1/pictures/nb_new-project-3.png
- - source: part-1/pictures/nb_new-project-4.png
- - source: part-1/pictures/nb_new-project-5.png
- - source: part-1/pictures/nb_newtool.png
- - source: part-1/pictures/nb_project_debug-1.png
- - source: part-1/pictures/nb_xds_options.png
- - source: part-1/pictures/xds-block-chain.png
- - source: part-1/pictures/xds-block-diagram.png
- - source: part-1/pictures/xds-conf.png
- - source: part-1/pictures/xds-dashboard-icon-1.png
- - source: part-1/pictures/xds-dashboard-icon-2.png
- - source: part-1/pictures/xds-dashboard-icon-3.png
- - source: part-1/pictures/xds-dashboard-prj-1.png
- - source: part-1/pictures/xds-dashboard-prj-2.png
- - source: part-1/pictures/xds-dashboard-sdks-install.png
- - source: part-1/pictures/xds-dashboard-sdks-mgt.png
- - source: part-2/0_Abstract.md
- - source: part-2/1_Prerequisites.md
- - source: part-2/1_xds-server/0_abstract.md
- - source: part-2/1_xds-server/1_build.md
- - source: part-2/1_xds-server/2_config.md
- - source: part-2/1_xds-server/3_how-to-run.md
- - source: part-2/1_xds-server/4_debug.md
- - source: part-2/1_xds-server/5_test.md
- - source: part-2/2_xds-agent/0_abstract.md
- - source: part-2/2_xds-agent/1_build.md
- - source: part-2/2_xds-agent/2_config.md
- - source: part-2/2_xds-agent/3_start.md
- - source: part-2/2_xds-agent/4_debug.md
- - source: part-2/3_xds-cli/0_abstract.md
- - source: part-2/3_xds-cli/1_build.md
- - source: part-2/3_xds-cli/2_config.md
- - source: part-2/3_xds-cli/3_commands.md
- - source: part-2/3_xds-cli/4_debug.md
- - source: part-2/4_xds-gdb/0_abstract.md
- - source: part-2/4_xds-gdb/1_build.md
- - source: part-2/4_xds-gdb/2_config.md
- - source: part-2/4_xds-gdb/3_debug.md
-
--
- url_fetch: GITHUB_FETCH
- url_edit: GITHUB_EDIT
- git_name: baylibre/agl-docs-baylibre
- git_commit: master
- documents:
- - source: CIAT/training/How_to_write_your_own_tests_for_AGL.pdf
- - source: CIAT/training/Hands_on_lab_documentation.pdf
--
- git_name: src/libappcontroller
- src_prefix: docs
- dst_prefix: ctrler
- documents:
- - source: Usage.md
- label: Usage
- - source: configSample.md
- label: Configuration Sample
- - source: controller.md
- label: Installation
- - source: controllerConfig.md
- label: Binding Configuration
--
- git_name: src/libafb-helpers
- src_prefix: docs
- dst_prefix: afb-helpers
- documents:
- - source: usage.md
- label: Usage
- - source: afb-timer.md
- label: AFB Timer
- - source: curl-wrap.md
- label: CURL wrapper
- - source: escape.md
- label: URL escaping
- - source: filescan-utils.md
- label: Filescan Utils
- - source: qafbwebsocketclient.md
- label: Qt AFB Websocket client
- - source: json.md
- label: JSON library for modern C++
- - source: wrap-json.md
- label: C JSON Wrapper
diff --git a/content/tocs_guppy/getting_started/fetched_files.yml b/content/tocs_guppy/getting_started/fetched_files.yml
deleted file mode 100644
index ba1fafe..0000000
--- a/content/tocs_guppy/getting_started/fetched_files.yml
+++ /dev/null
@@ -1,92 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-#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: source-code.md
- label: Download AGL Source Code
- - source: customize_bitbake_conf.md
- label: Customize the AGL build
- - source: machines/intel.md
- label: Build for Intel
- - 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: troubleshooting.md
- label: Generic issues
- - source: footers/intel-footer.md
- label: Intel Boards
- - source: footers/raspberrypi-footer.md
- 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
--
- 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_guppy/hardware/fetched_files.yml b/content/tocs_guppy/hardware/fetched_files.yml
deleted file mode 100644
index f1decf7..0000000
--- a/content/tocs_guppy/hardware/fetched_files.yml
+++ /dev/null
@@ -1,56 +0,0 @@
-##############################################################################################################
-# GLOBAL DOCUMENT
-# <any REPOSITORY option>: global setting
-# repositories: array of objects with documents to fetchd
-#
-# REPOSITORY ENTRY:
-# -
-# url_fetch: gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
-# url_edit: gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
-# git_name: repository name (%repo%)
-# git_commit: git reference: revision, SHA1, branch... (%commit%)
-# src_prefix: prefix prepended to %source%
-# dst_prefix: prefix prepended to destination name
-# documents: array of documents to fetch
-#
-# DOCUMENT ENTRY:
-# source: subpath within repository (%source%)
-# destination: local destination filename
-# label|title: name within TOC
-# edit|editURI: specific edition URI
-#
-# EXAMPLE:
-# ------------------------------------
-# url: "GERRIT_FETCH"
-# git_commit: "master"
-# repositories:
-# -
-# git_name: src/foo
-# src_prefix: docs
-# dst_prefix: foodocs
-# documents:
-# - source: intro.md
-# label: Introduction
-# - source: topic/README.md
-# destination: topic.md
-# label: My Topic
-# ------------------------------------
-##############################################################################################################
-
-#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/setupdocs.sh b/setupdocs.sh
index ba40116..6450b31 100755
--- a/setupdocs.sh
+++ b/setupdocs.sh
@@ -51,13 +51,15 @@ Usage: $PROGNAME [OPTIONS]... [DIRECTORY]
REFERENCE can be a branch, a tag, a commit
-w, --webtemplate-ref=[REFERENCE] webtemplates reference;
REFERENCE can be a branch, a tag, a commit
+ -b, --baseurl=[DST] baseurl of the site, defaut is empty
+ DST must start with /
EOF
exit 1
}
-SHORTOPTS="w:t:d:h"
-LONGOPTS="webtemplate-ref:,doctools-ref:,directory:,debug,help"
+SHORTOPTS="w:t:d:h:b:"
+LONGOPTS="webtemplate-ref:,doctools-ref:,baseurl:,directory:,debug,help"
ARGS=$(getopt -s bash --options $SHORTOPTS \
--longoptions $LONGOPTS --name $PROGNAME -- "$@" )
if [ ! $? -eq 0 ]; then
@@ -73,6 +75,8 @@ while [ "$#" -gt "1" ]; do
ref_doctools=$2; shift 2;;
-d|--directory)
DESTINATION=$2;shift 2;;
+ -b|--baseurl)
+ baseurl=$2;shift 2;;
--debug)
DEBUG=0;shift 2;;
-h|--help)
@@ -111,9 +115,12 @@ debug "GITREF=$GITREF and rev=$rev"
&& { error "Invalid reference between $ref_docswebtemplate and local repo in $DESTINATION"; exit 5; }
#processing cloning or update
if [ -z $GITREF ]; then
- echo "Cloning docwebtemplates and doctools in $DESTINATION"
+ echo "Cloning docwebtemplates and doctools in $DESTINATION with baseurl=${baseurl}"
gitclone $docswebtemplates .
gitcheckout $ref_docswebtemplate
+ if [ ! -z ${baseurl} ]; then
+ sed -i "s|^baseurl:.*$|baseurl: \"${baseurl}\"|g" conf/_dev.yml
+ fi
gitclone $doctools $DOCTOOLSDIR
pushd $DOCTOOLSDIR
gitcheckout $ref_doctools
diff --git a/site/.htaccess b/site/.htaccess
index 61548b8..1decfc7 100644
--- a/site/.htaccess
+++ b/site/.htaccess
@@ -30,7 +30,7 @@ RewriteEngine on
# Some of the below redirects are 302s, and some are 301s. 302s are used
# for redirects whose targets change sometimes. For example:
# - /docs/ -> /docs/fr/, /docs/en/, etc.
-# - /docs/en/ -> /docs/en/dev/, /docs/en/latest/, etc.
+# - /docs/en/ -> /docs/en/master/, /docs/en/latest/, etc.
# - /docs/en/latest -> /docs/en/4.0.0/, /docs/en/5.0.0/, etc.
#
# 301s are for PERMANENT redirects. These are used only for mapping old
@@ -38,7 +38,7 @@ RewriteEngine on
#
# NOTE:
# (\w\w(?:-\w\w)?) - regex for languages
-# (?:\d+\.(?:\d+\.\d+|x))|dev|latest - regex for versions
+# (?:\d+\.(?:\d+\.\d+|x))|master|latest - regex for versions
#
# NOTE:
# Meanings of some of the flags at the ends of rules:
@@ -75,7 +75,7 @@ RewriteRule ^.*docs/(\w\w(?:-\w\w)?)/latest$ {{site.baseurl}}/docs/$1/latest/ [R
#
# docs/XX/* -> docs/YY/*
#
-{% for redirect in site.data.redirects.language-renames %}RewriteRule ^.*docs/{{redirect[0]}}/((?:\d+\.(?:\d+\.\d+|x))|dev|latest)/(.*)$ {{site.baseurl}}/docs/{{redirect[1]}}/$1/$2 [R=302,L]
+{% for redirect in site.data.redirects.language-renames %}RewriteRule ^.*docs/{{redirect[0]}}/((?:\d+\.(?:\d+\.\d+|x))|master|latest)/(.*)$ {{site.baseurl}}/docs/{{redirect[1]}}/$1/$2 [R=302,L]
{% endfor %}
# 301 (PERMANENT):
@@ -87,7 +87,7 @@ RewriteRule ^.*docs/(\w\w(?:-\w\w)?)/latest$ {{site.baseurl}}/docs/$1/latest/ [R
# by site.baseurl. It is thrown away because there is no RewriteCond to
# control whether the rewrite happens to a URI or a local file path
# (when Apache is locating the local file to serve).
-{% for redirect in site.data.redirects.docs-global %}RewriteRule ^.*docs/(\w\w(?:-\w\w)?)/((?:\d+\.(?:\d+\.\d+|x))|dev|latest)/{{redirect[0]}}$ {{site.baseurl}}/docs/$1/$2/{{redirect[1]}} [NE,R=301,L]
+{% for redirect in site.data.redirects.docs-global %}RewriteRule ^.*docs/(\w\w(?:-\w\w)?)/((?:\d+\.(?:\d+\.\d+|x))|master|latest)/{{redirect[0]}}$ {{site.baseurl}}/docs/$1/$2/{{redirect[1]}} [NE,R=301,L]
{% endfor %}
# 301 (PERMANENT):
diff --git a/site/_data/redirects.yml b/site/_data/redirects.yml
index 3f10f41..1c6a427 100644
--- a/site/_data/redirects.yml
+++ b/site/_data/redirects.yml
@@ -3,7 +3,6 @@
# 302 (temporary) renames of versions
version-renames:
- "master": "dev"
"1.0": "1.x"
"2.0": "2.x"
"2.0.1": "2.x"
diff --git a/site/_includes/header.html b/site/_includes/header.html
index 6828472..a421f1c 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.baseurl }}{{ 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.baseurl }}{{ 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.baseurl }}{{ 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.baseurl }}{{ site.docsurl }}/{{LANGUAGE}}/{{VERSION}}/devguides/">Developer Guides</a>
+ </li>
+
+ <li {% if page.appfw_tab %}class="active"{% endif %}>
+ <a href="{{ site.baseurl }}{{ site.docsurl }}/{{LANGUAGE}}/{{VERSION}}/apis_services/">APIs & Services</a>
</li>
-
+
+ <li {% if page.appfw_tab %}class="active"{% endif %}>
+ <a href="{{ site.baseurl }}{{ 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.baseurl }}{{ site.docsurl }}/{{LANGUAGE}}/{{VERSION}}/reference/">Reference</a>
</li>
</ul>
</div>
diff --git a/site/_layouts/doc.html b/site/_layouts/doc.html
index 0c39a1e..2b6cf39 100644
--- a/site/_layouts/doc.html
+++ b/site/_layouts/doc.html
@@ -3,7 +3,7 @@ layout: base
docs_tab: true
analytics_id: {{site.ganalytics}}
-scripts:
+scripts:
- lib/raphael-min.js
- lib/underscore-min.js
- lib/sequence-diagram-min.js
@@ -11,21 +11,28 @@ scripts:
- process-uml.js
---
-{% include header.html %}
-
{% comment %}
set some constants
{% endcomment %}
{% assign ALL_PAGES = site.data.all-pages %}
-{% assign DOCSDIR = site.docsurl %}
+{% capture DOCSDIR %}{{ site.baseurl }}{{ site.docsurl }}{% endcapture %}
{% 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 %}{{ site.docsurl }}/{{ 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">
@@ -63,10 +70,10 @@ set some constants
Edit-links obey the following rules:
- if page in /dev/ or /latest/:
- show edit link for /dev/ page in source language
+ if page in /master/ or /latest/:
+ show edit link for /master/ page in source language
if page not in source language:
- show translation link for /dev/ page
+ show translation link for /master/ page
else:
show edit link for the page in its version and language
@@ -76,13 +83,13 @@ set some constants
{% capture base_edit_link %}{{ site.urls.edit_git }}{{ page.path }}{% endcapture %}
{% capture base_version %}/{{ page.version }}/{% endcapture %}
{% capture base_language %}/{{ page.language }}/{% endcapture %}
- {% capture dev_version %}/dev/{% endcapture %}
+ {% capture master_version %}/master/{% endcapture %}
{% capture src_language %}/{{ site.src_language }}/{% endcapture %}
{% comment %}
Edit-links for current pages in non-source languages
NOTE:
- Pages that are under /dev/ or /latest/ (i.e. site.latest_docs_version) have page.current set to "true".
+ Pages that are under /master/ or /latest/ (i.e. site.latest_docs_version) have page.current set to "true".
{% endcomment %}
{% if page.language != site.src_language and page.current %}
@@ -91,10 +98,10 @@ set some constants
{% endcomment %}
{% capture page_path_prefix %}docs/{{ page.language }}/{{ page.version }}{% endcapture %}
{% assign page_path_end = page.path | split:"/" | last %}
- {% assign crowdin_path = page.path | replace:page_path_prefix,"docs/en/dev" | replace:page_path_end,"" %}
+ {% assign crowdin_path = page.path | replace:page_path_prefix,"docs/en/master" | replace:page_path_end,"" %}
{% capture crowdin_link %}https://crowdin.com/project/cordova/{{ page.language }}#/cordova-docs/{{ crowdin_path }}{% endcapture %}
- {% assign edit_link = base_edit_link | replace:base_language,src_language | replace:base_version,dev_version %}
+ {% assign edit_link = base_edit_link | replace:base_language,src_language | replace:base_version,master_version %}
<a class="edit" href="{{ edit_link }}"><span class="glyphicon glyphicon-pencil" aria-hidden="true"></span> {{ page.edit_source_text }}</a>
<a class="edit" href="{{ crowdin_link }}"><span class="glyphicon glyphicon-pencil" aria-hidden="true"></span> {{ page.edit_translation_text }}</a>
@@ -105,10 +112,10 @@ set some constants
{% else %}
{% comment %}
- Edit-link for latest version points to dev instead
+ Edit-link for latest version points to master instead
{% endcomment %}
{% if page.version == site.latest_docs_version %}
- {% assign edit_link = base_edit_link | replace:base_version,dev_version %}
+ {% assign edit_link = base_edit_link | replace:base_version,master_version %}
{% else %}
{% assign edit_link = base_edit_link %}
{% endif %}
@@ -119,14 +126,13 @@ set some constants
-->
<!-- Language dropdown -->
- <!--
<div class="dropdown">
<button class="btn btn-default dropdown-toggle" type="button" id="languageDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true">
{{ site.data.docs-versions[page.language].name }}
<span class="caret"></span>
</button>
- <!-- List all languages - ->
+ <!-- List all languages -->
<ul class="dropdown-menu" aria-labelledby="languageDropdown">
{% for other_language_entry in site.data.docs-versions %}
@@ -157,10 +163,8 @@ set some constants
{% endfor %}
</ul>
</div>
- -->
<!-- Version dropdown -->
- <!--
<div class="dropdown">
<button class="btn btn-default dropdown-toggle" type="button" id="versionDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true">
{{ page.version }}
@@ -171,7 +175,7 @@ set some constants
</button>
<ul class="dropdown-menu" aria-labelledby="versionDropdown">
- <!-- List versions available in this language - ->
+ <!-- List versions available in this language -->
{% for other_version in site.data.docs-versions[page.language].versions reversed %}
<li>
{% comment %}
@@ -198,14 +202,15 @@ set some constants
This page might not exist in the target version because page
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 %}
+ {% capture other_version_root %}{{site.docsurl}}/{{ page.language }}/{{ other_version_string }}/{% endcapture %}
+ {% 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 }}
@@ -218,9 +223,8 @@ set some constants
{% endfor %}
</ul>
</div>
- -->
</div>
-
+
{% comment %}
Get URL for this page in the latest version
@@ -236,13 +240,13 @@ set some constants
{% endunless %}
<!-- Show warnings for special versions -->
- <!-- dev warning
- {% if page.version == 'dev' %}
+ <!-- master warning
+ {% if page.version == 'master' %}
<div class="alert docs-alert alert-info" role="alert">
<button type="button" class="close" data-dismiss="alert" aria-label="Close">
<span aria-hidden="true">&times;</span>
</button>
- {{ site.message.indev }}
+ {{ site.message.inmaster }}
<a href="{{ site.baseurl }}{{ latest_url }}">
{{ page.click_here_text }}
</a>
@@ -251,7 +255,7 @@ set some constants
-->
<!-- outdated warning
- {% if page.version != 'dev' and page.version != site.latest_docs_version %}
+ {% if page.version != 'master' and page.version != site.latest_docs_version %}
<div class="alert docs-alert alert-danger" role="alert">
<button type="button" class="close" data-dismiss="alert" aria-label="Close">
<span aria-hidden="true">&times;</span>
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..3c28cdc 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.baseurl}}{{ site.docsurl }}/en/{{ site.default_linked_docs_version }}/getting_started/">Getting started</a></h3>
+ <h3><a href="{{site.baseurl}}{{ site.docsurl }}/en/{{ site.default_linked_docs_version }}/hardware/">Hardware Support</a></h3>
+ <h3><a href="{{site.baseurl}}{{ site.docsurl }}/en/{{ site.default_linked_docs_version }}/architecture/">Architecture Guides</a></h3>
+ <h3><a href="{{site.baseurl}}{{ site.docsurl }}/en/{{ site.default_linked_docs_version }}/devguides/">Developer Guides</a></h3>
+ <h3><a href="{{site.baseurl}}{{ site.docsurl }}/en/{{ site.default_linked_docs_version }}/apis_services/">APIs & Services</a></h3>
+ <h3><a href="{{site.baseurl}}{{ site.docsurl }}/en/{{ site.default_linked_docs_version }}/howto/">How To</a></h3>
+ <h3><a href="{{site.baseurl}}{{ 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 36aad16..1a2137e 100644
--- a/site/index.html
+++ b/site/index.html
@@ -19,7 +19,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">
@@ -56,7 +56,7 @@ change_frequency: monthly
</div>
<div class="blue-divider"></div>
-
+
<!-- /container -->
<div class="blue-divider"></div>
@@ -66,7 +66,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>