aboutsummaryrefslogtreecommitdiffstats
path: root/contain/tocs/devguides
diff options
context:
space:
mode:
Diffstat (limited to 'contain/tocs/devguides')
-rw-r--r--contain/tocs/devguides/fetched_files.yml79
-rw-r--r--contain/tocs/devguides/toc_dev_en.yml66
2 files changed, 145 insertions, 0 deletions
diff --git a/contain/tocs/devguides/fetched_files.yml b/contain/tocs/devguides/fetched_files.yml
new file mode 100644
index 0000000..e373840
--- /dev/null
+++ b/contain/tocs/devguides/fetched_files.yml
@@ -0,0 +1,79 @@
+##############################################################################################################
+# 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: sdk/AGL-Devkit-Image-and-SDK-for-porter.pdf
+ - source: sdk/AGL-Devkit-Build-your-1st-AGL-Application.pdf
+ - source: bsp/AGL_Phase2-Devkit-HowTo_bake_a_service.pdf
+ - source: appfw/03-AGL-AppFW-Privileges-Management.pdf
+
diff --git a/contain/tocs/devguides/toc_dev_en.yml b/contain/tocs/devguides/toc_dev_en.yml
new file mode 100644
index 0000000..6d9b419
--- /dev/null
+++ b/contain/tocs/devguides/toc_dev_en.yml
@@ -0,0 +1,66 @@
+#######################################################################
+# 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: reference/meta-sota.html
+-
+ name: Guides
+ children:
+ -
+ name: Kickstart on Renesas Porter board
+ url: reference/iotbzh2016/sdk/AGL-Kickstart-on-Renesas-Porter-board.pdf
+ -
+ name: Devkit - Image and SDK for Porter board
+ url: reference/iotbzh2016/sdk/AGL-Devkit-Image-and-SDK-for-porter.pdf
+ -
+ name: Devkit - Build your 1st AGL Application
+ url: reference/iotbzh2016/sdk/AGL-Devkit-Build-your-1st-AGL-Application.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