diff options
| author |   Clément Bénier <clement.benier@iot.bzh> | 2019-03-29 16:56:08 +0100 |
|---|---|---|
| committer | Clément Bénier <clement.benier@iot.bzh> | 2019-03-29 17:04:38 +0100 |
| commit | a734c2f254fe669c20a8fc62a8c4497a5edf708a (patch) | |
| tree | a5fb597c483c9fc4242f339382921396c0cca437 /content/tocs | |
| parent | ddb7b9f1ac7e5b74d4f11f4149456b627b6af439 (diff) | |
| parent | 657afcf4e2bb93255d722b8019a2a352ffc534d1 (diff) | |
Merge remote-tracking branch 'origin/master-next'
Diffstat (limited to 'content/tocs')
27 files changed, 738 insertions, 915 deletions
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 |