diff options
Diffstat (limited to 'site/_tocs/apis_services/fetched_files.yml')
| -rw-r--r-- | site/_tocs/apis_services/fetched_files.yml | 94 |
1 files changed, 77 insertions, 17 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 +# <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" -#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 |