diff options
Diffstat (limited to 'content/tocs/devguides')
| -rw-r--r-- | content/tocs/devguides/fetched_files.yml | 127 | ||||
| -rw-r--r-- | content/tocs/devguides/toc_dev_en.yml | 105 |
2 files changed, 232 insertions, 0 deletions
diff --git a/content/tocs/devguides/fetched_files.yml b/content/tocs/devguides/fetched_files.yml new file mode 100644 index 0000000..733b8f1 --- /dev/null +++ b/content/tocs/devguides/fetched_files.yml @@ -0,0 +1,127 @@ +############################################################################################################## +# 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 +- + git_name: AGL/meta-agl-extra + documents: + - source: meta-sota/README.md + destination: meta-sota.md + label: meta-sota +- + url_fetch: http://iot.bzh/download/public/2016/%source% + dst_prefix: iotbzh2016 + documents: + - source: sdk/AGL-Kickstart-on-Renesas-Porter-board.pdf + - source: bsp/AGL_Phase2-Devkit-HowTo_bake_a_service.pdf + - source: appfw/03-AGL-AppFW-Privileges-Management.pdf +- + url_fetch: "GITHUB_FETCH" + git_name: iotbzh/agl-documentation + git_commit: "master" + documents: + - source: sdk-devkit/docs/part-1/1_0_Abstract.md + - source: sdk-devkit/docs/part-1/1_1-Deploy_image.md + - source: sdk-devkit/docs/part-1/1_2-Setting-up-your_os.md + - source: sdk-devkit/docs/part-1/1_3-Install-agl-for-porter.md + - source: sdk-devkit/docs/part-1/1_4-Inside-the-container.md + - source: sdk-devkit/docs/part-1/1_5-Build-image-Porter.md + - source: sdk-devkit/docs/part-1/1_6-Porter-image-deployment.md + - source: sdk-devkit/docs/part-1/1_7-SDK-compilation-installation.md + - source: sdk-devkit/docs/part-1/pictures/docker_install_macos_1.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_macos_2.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_macos_3.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_macos_4.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_macos_5.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_macos_6.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_1.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_2.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_3.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_4.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_5.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_6.png + - source: sdk-devkit/docs/part-1/pictures/docker_install_windows_7.png + - source: sdk-devkit/docs/part-1/pictures/renesas_download.jpg + - source: sdk-devkit/docs/part-1/pictures/windows_putty_1.png + - source: sdk-devkit/docs/part-1/pictures/windows_putty_2.png + - source: sdk-devkit/docs/part-1/pictures/windows_win32diskimager_1.png + - source: sdk-devkit/docs/part-1/pictures/windows_win32diskimager_2.png + - source: sdk-devkit/docs/part-1/pictures/windows_win32diskimager_3.png + - source: sdk-devkit/docs/part-1/pictures/windows_win32diskimager_4.png + - source: sdk-devkit/docs/part-1/pictures/windows_win32diskimager_5.png + - source: sdk-devkit/docs/part-2/2_0_Abstract.md + - source: sdk-devkit/docs/part-2/2_1-Init-sdk-env.md + - source: sdk-devkit/docs/part-2/2_2-Trying-out-templates.md + - source: sdk-devkit/docs/part-2/2_3-Dev-with-container.md + - source: sdk-devkit/docs/part-2/2_4-Creating-hybrid-app.md + - source: sdk-devkit/docs/part-2/pictures/cpu_hybrid_qml.png + - source: sdk-devkit/docs/part-2/pictures/html5_app.png + - source: sdk-devkit/docs/part-2/pictures/hybrid_html5_app_on_target.png + - source: sdk-devkit/docs/part-2/pictures/hybrid_html5_app.png + - source: sdk-devkit/docs/part-2/pictures/hybrid_qml_app.png + - source: sdk-devkit/docs/part-2/pictures/mac_x11_logo.png + - source: sdk-devkit/docs/part-2/pictures/putty_config.png + - source: sdk-devkit/docs/part-2/pictures/qml_app.png + - source: sdk-devkit/docs/part-2/pictures/web-runtime_app.png + - source: sdk-devkit/docs/part-2/pictures/xming_server.png + + diff --git a/content/tocs/devguides/toc_dev_en.yml b/content/tocs/devguides/toc_dev_en.yml new file mode 100644 index 0000000..e2bc729 --- /dev/null +++ b/content/tocs/devguides/toc_dev_en.yml @@ -0,0 +1,105 @@ +####################################################################### +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes +# +# +############################ SYNTAX ################################### +# GLOBAL OPTIONS: +# name: TOC (page) title +# template: name of template to use for this page - use 'generated_index.html' if unknown +# children: array of TOC entries +# +# TOC Entry: +# name: TOC entry (level 1) +# children: +# - +# name: optional name for TOC entry (default: use URL FrontMatter info) +# url: <subdir as defined with FETCH_DIR in conf/AppDefaults.js: +# - +# name: ... +# url: ... +# ... +# +# EXAMPLE: +# ------------------------------- +# name: Developer Guides +# template: generated_index.html +# children: +# - +# name: Application Framework +# children: +# - url: reference/af-main/overview.html +# - url: reference/af-main/afm-system-daemon.html +# - url: reference/af-main/afm-user-daemon.html +# ------------------------------- +####################################################################### + +name: Developer Guides +template: generated_index.html +children: +- + name: Yocto layers + children: + - url: reference/AGL.html + - url: reference/meta-agl.html + - url: reference/meta-agl-demo.html + - url: reference/meta-agl-devel.html + - url: referece/meta-sota.html +- + name: "Development Kit: build AGL image" + children: + - + name: Abstract + url: reference/sdk-devkit/docs/part-1/1_0_Abstract.html + - + name: Deploy image + url: reference/sdk-devkit/docs/part-1/1_1-Deploy_image.html + - + name: Setting up your operating system + url: reference/sdk-devkit/docs/part-1/1_2-Setting-up-your_os.html + - + name: Install Docker image + url: reference/sdk-devkit/docs/part-1/1_3-Install-agl-for-porter.html + - + name: Inside the container + url: reference/sdk-devkit/docs/part-1/1_4-Inside-the-container.html + - + name: Build image for Porter + url: reference/sdk-devkit/docs/part-1/1_5-Build-image-Porter.html + - + name: Porter image deployment + url: reference/sdk-devkit/docs/part-1/1_6-Porter-image-deployment.html + - + name: SDK compilation and installation + url: reference/sdk-devkit/docs/part-1/1_7-SDK-compilation-installation.html +- + name: "Development Kit: build AGL application" + children: + - + name: Abstract + url: reference/sdk-devkit/docs/part-2/2_0_Abstract.html + - + name: Initialize SDK environment + url: reference/sdk-devkit/docs/part-2/2_1-Init-sdk-env.html + - + name: Trying out templates + url: reference/sdk-devkit/docs/part-2/2_2-Trying-out-templates.html + - + name: Developing with container + url: reference/sdk-devkit/docs/part-2/2_3-Dev-with-container.html + - + name: Creating an hybrid app + url: reference/sdk-devkit/docs/part-2/2_4-Creating-hybrid-app.html +- + name: Guides + children: + - + name: Kickstart on Renesas Porter board + url: reference/iotbzh2016/sdk/AGL-Kickstart-on-Renesas-Porter-board.pdf + - + name: Devkit - Howto bake a service + url: reference/iotbzh2016/bsp/AGL_Phase2-Devkit-HowTo_bake_a_service.pdf + - + name: AppFW - Privileges Management + url: reference/iotbzh2016/appfw/03-AGL-AppFW-Privileges-Management.pdf |