From 96baf20ed87b231082751481c1dbcfd737851ff2 Mon Sep 17 00:00:00 2001 From: Stephane Desneux Date: Tue, 15 Nov 2016 02:10:13 +0100 Subject: webdocs: allow fetching PDFs; update documentation in _tocs files Change-Id: I9b677f0ad3b161ffb12471a989f5e8ca455baab2 Signed-off-by: Stephane Desneux --- site/_tocs/apis_services/fetched_files.yml | 94 +++++++++++++++++++++++----- site/_tocs/apis_services/toc_dev_en.yml | 43 +++++++++++++ site/_tocs/architecture/fetched_files.yml | 64 ++++++++++--------- site/_tocs/architecture/toc_dev_en.yml | 41 +++++++++--- site/_tocs/devguides/fetched_files.yml | 60 +++++++++++++----- site/_tocs/devguides/toc_dev_en.yml | 52 ++++++++++++++- site/_tocs/getting_started/fetched_files.yml | 50 ++++++++++----- site/_tocs/getting_started/toc_dev_en.yml | 33 ++++++++++ site/_tocs/hardware/fetched_files.yml | 50 ++++++++++----- site/_tocs/hardware/toc_dev_en.yml | 33 ++++++++++ 10 files changed, 424 insertions(+), 96 deletions(-) diff --git a/site/_tocs/apis_services/fetched_files.yml b/site/_tocs/apis_services/fetched_files.yml index ae29d2c..a8d51d1 100644 --- a/site/_tocs/apis_services/fetched_files.yml +++ b/site/_tocs/apis_services/fetched_files.yml @@ -1,24 +1,44 @@ -# REFERENCE ENTRY: +############################################################################################################## +# GLOBAL DOCUMENT +# : 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" -#git_commit : # default defined in _tocs/xxxx/latest.yml -#dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) repositories: - @@ -61,5 +81,45 @@ repositories: - source: afb-bindings-overview.md label: Bindings Examples - source: FAQ.md - +- + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: automotive-grade-linux/docs-agl + git_commit: master + src_prefix: docs/app-framework + dst_prefix: af-binder + documents: + - source: index.md + destination: resources.md + label: Resources +- + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: automotive-grade-linux/docs-agl + git_commit: master + src_prefix: docs/signaling + dst_prefix: signaling + documents: + - source: architecture.md + destination: architecture.md + label: Signaling Architecture (proposal) + - 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/distributed-arch.svg + - source: images/signal-agent-arch.svg +- + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: automotive-grade-linux/docs-agl + git_commit: master + src_prefix: docs/audio + dst_prefix: audio + documents: + - source: index.md + destination: resources.md + label: Resources diff --git a/site/_tocs/apis_services/toc_dev_en.yml b/site/_tocs/apis_services/toc_dev_en.yml index fd83f87..1262d1a 100644 --- a/site/_tocs/apis_services/toc_dev_en.yml +++ b/site/_tocs/apis_services/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: : 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 : "GITHUB_FETCH" url_edit : "GITHUB_EDIT" @@ -77,17 +99,3 @@ repositories: label: Threat Analysis - source: 06-attack-surfaces.md label: Attack Surfaces -- - git_name : automotive-grade-linux/docs-agl - src_prefix : docs - dst_prefix: components - documents: - - source: app-framework/index.md - destination: app-framework.md - label: Application Framework - - source: signaling/index.md - destination: signaling.md - label: Message signaling - - source: audio/index.md - destination: audio.md - label: Audio Framework diff --git a/site/_tocs/architecture/toc_dev_en.yml b/site/_tocs/architecture/toc_dev_en.yml index 05f8416..64d452e 100644 --- a/site/_tocs/architecture/toc_dev_en.yml +++ b/site/_tocs/architecture/toc_dev_en.yml @@ -1,12 +1,45 @@ +####################################################################### # 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: : 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: : 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 : "GITHUB_FETCH" url_edit : "GITHUB_EDIT" diff --git a/site/_tocs/getting_started/toc_dev_en.yml b/site/_tocs/getting_started/toc_dev_en.yml index 2681bb8..fb284a4 100644 --- a/site/_tocs/getting_started/toc_dev_en.yml +++ b/site/_tocs/getting_started/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: : 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" diff --git a/site/_tocs/hardware/toc_dev_en.yml b/site/_tocs/hardware/toc_dev_en.yml index 46b2509..d975f86 100644 --- a/site/_tocs/hardware/toc_dev_en.yml +++ b/site/_tocs/hardware/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: