diff options
Diffstat (limited to 'site/_tocs/devguides')
| -rw-r--r-- | site/_tocs/devguides/fetched_files.yml | 60 | ||||
| -rw-r--r-- | site/_tocs/devguides/toc_dev_en.yml | 52 |
2 files changed, 96 insertions, 16 deletions
diff --git a/site/_tocs/devguides/fetched_files.yml b/site/_tocs/devguides/fetched_files.yml index fc9a449..76e240d 100644 --- a/site/_tocs/devguides/fetched_files.yml +++ b/site/_tocs/devguides/fetched_files.yml @@ -1,19 +1,41 @@ -# REFERENCE ENTRY: +############################################################################################################## +# 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% %uri% -# GERRIT_FETCH= "https://gerrit.automotivelinux.org/gerrit/gitweb?p=%repo%;a=blob_plain;f=%source%;hb=%commit%" -# GITHUB_FETCH= "https://raw.githubusercontent.com/%repo%/%commit%/%source%" -# repository: git repository name -# GITHUB_EDIT= "https://raw.github.com/%repo%/blob/%commit%/%source%" -# git_commit: git commit when not default -# destination_prefix: optional destination prefix -# documents: -# - -# source : "source patch within url_fetch" -# destination : "optional: destination path default=path.join(destination_prefix+source)" -# label: "optional: friendly name for submenu default=basename(source) overloaded by file content" -# title: "optional: info about document (default label, overloaded by file content)" +# 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: master @@ -45,5 +67,13 @@ repositories: - 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/site/_tocs/devguides/toc_dev_en.yml b/site/_tocs/devguides/toc_dev_en.yml index 2bf81a1..234c0ba 100644 --- a/site/_tocs/devguides/toc_dev_en.yml +++ b/site/_tocs/devguides/toc_dev_en.yml @@ -1,6 +1,39 @@ +####################################################################### # 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/AppDefault.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 @@ -13,4 +46,21 @@ children: - 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/iotbzh2016appfw/03-AGL-AppFW-Privileges-Management.pdf |