diff options
author | Stephane Desneux <stephane.desneux@iot.bzh> | 2016-11-10 17:47:20 +0100 |
---|---|---|
committer | Stephane Desneux <stephane.desneux@iot.bzh> | 2016-11-10 23:30:34 +0100 |
commit | fe095ae8c3010b03953da26fd92b518966139c78 (patch) | |
tree | 4d463714450264a553dcb0e52bfeff9d8c999aa4 /site/_tocs | |
parent | 4000a79371d7cb0b798779521f2e0a4a9fc22bee (diff) |
webdocs-agl: renamed sections
Change-Id: I9019929e724b4d09617b3b1258703519e7f0aa58
Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
Diffstat (limited to 'site/_tocs')
-rw-r--r-- | site/_tocs/apis_services/fetched_files.yml (renamed from site/_tocs/quickstart/fetched_files.yml) | 17 | ||||
-rw-r--r-- | site/_tocs/apis_services/toc_dev_en.yml | 9 | ||||
-rw-r--r-- | site/_tocs/architecture/fetched_files.yml | 40 | ||||
-rw-r--r-- | site/_tocs/architecture/toc_dev_en.yml | 17 | ||||
-rw-r--r-- | site/_tocs/bindings/fetched_files.yml | 42 | ||||
-rw-r--r-- | site/_tocs/bindings/toc_dev_en.yml | 20 | ||||
-rw-r--r-- | site/_tocs/getting_started/fetched_files.yml | 44 | ||||
-rw-r--r-- | site/_tocs/getting_started/toc_dev_en.yml | 21 | ||||
-rw-r--r-- | site/_tocs/hardware/fetched_files.yml | 21 | ||||
-rw-r--r-- | site/_tocs/hardware/toc_dev_en.yml | 12 | ||||
-rw-r--r-- | site/_tocs/quickstart/toc_dev_en.yml | 19 |
11 files changed, 79 insertions, 183 deletions
diff --git a/site/_tocs/quickstart/fetched_files.yml b/site/_tocs/apis_services/fetched_files.yml index 8f2095a..86318a4 100644 --- a/site/_tocs/quickstart/fetched_files.yml +++ b/site/_tocs/apis_services/fetched_files.yml @@ -15,18 +15,5 @@ # title: "optional: info about document (default label, overloaded by file content)" # -url_fetch : "GITHUB_FETCH" -url_edit : "GITHUB_EDIT" -git_commit : "master" -#dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) - -repositories: -- - git_name : "iotbzh/agl-porter" - documents : - - source: "guide/booting-agl-sdk.md" -- - git_name : "iotbzh/agl-qmu" - documents : - - source: "guide/booting-agl-sdk.md" - +url_fetch : "GERRIT_FETCH" +repositories: diff --git a/site/_tocs/apis_services/toc_dev_en.yml b/site/_tocs/apis_services/toc_dev_en.yml new file mode 100644 index 0000000..5511f41 --- /dev/null +++ b/site/_tocs/apis_services/toc_dev_en.yml @@ -0,0 +1,9 @@ +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes + +name: APIs & Services +template: generated_index.html +children: + + diff --git a/site/_tocs/architecture/fetched_files.yml b/site/_tocs/architecture/fetched_files.yml index 2638640..4f18585 100644 --- a/site/_tocs/architecture/fetched_files.yml +++ b/site/_tocs/architecture/fetched_files.yml @@ -15,47 +15,9 @@ # title: "optional: info about document (default label, overloaded by file content)" # -url_fetch : "GERRIT_FETCH" +url_fetch : "GITHUB_FETCH" commit : "master" #git_commit : # default defined in _tocs/xxxx/latest.yml #dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) repositories: -- - git_name : "src/app-framework-main.git" - dst_prefix : "ap/main" - src_prefix : "docs" - documents : - - source: "overview.md" - label: "afm overview" - - source: "afm-system-daemon.md" - - source: "afm-user-daemon.md" - -- - git_name : "src/app-framework-binder.git" - src_prefix : "doc" - dst_prefix : "ap/binder" - documents : - - source: "afb-overview.md" - - source: "afb-application-writing.md" - - source: "afb-bindings-overview.md" - - source: "afb-bindings-writing.md" - - label: "afb basic test" - source: "afb-tests-overview.md" - - label: "afb vocabulary" - source: "afb-daemon-vocabulary.md" -#- -# git_name : "docs/security-blueprint" -# dst_prefix : "security/blueprint" -# documents : -# - source: "overview.md" -# - source: "risks.md" -# - source: "attack-surface.md" -# -#- -# git_name : "docs/aglcore-specifications" -# dst_prefix : "specifications/aglcore" -# documents : -# - source: "overview.md" -# - source: "risks.md" -# - source: "attack-surface.md" diff --git a/site/_tocs/architecture/toc_dev_en.yml b/site/_tocs/architecture/toc_dev_en.yml index 0649a73..ada3ecc 100644 --- a/site/_tocs/architecture/toc_dev_en.yml +++ b/site/_tocs/architecture/toc_dev_en.yml @@ -2,22 +2,7 @@ # - TOC should reference .HTML and .md (Index OK but Error 404) # - do not forget to run 'docbuild --tocs' after any changes -name: Architecture +name: Architecture Guides template: generated_index.html children: -- - name: Introduction to AGL project - children: - - url: reference/ap/main/overview.html - - url: reference/ap/binder/afb-overview.html - - url: reference/ap/binder/afb-bindings-overview.html -- - name: Booting AGL on your target - children: - - url: reference/ap/main/afm-system-daemon.html - - url: reference/ap/main/afm-user-daemon.html - - url: reference/ap/binder/afb-application-writing.html - - url: reference/ap/binder/afb-bindings-writing.html - - diff --git a/site/_tocs/bindings/fetched_files.yml b/site/_tocs/bindings/fetched_files.yml deleted file mode 100644 index e6d6d9f..0000000 --- a/site/_tocs/bindings/fetched_files.yml +++ /dev/null @@ -1,42 +0,0 @@ -# REFERENCE 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 : "GERRIT_FETCH" -repositories: -- - git_name : "src/app-framework-main.git" - dst_prefix : "ap/main" - src_prefix : "docs" - documents : - - source: "overview.md" - label: "afm overview" - - source: "afm-system-daemon.md" - - source: "afm-user-daemon.md" - -- - git_name : "src/app-framework-binder.git" - src_prefix : "doc" - dst_prefix : "ap/binder" - documents : - - source: "afb-overview.md" - - source: "afb-application-writing.md" - - source: "afb-bindings-overview.md" - - source: "afb-bindings-writing.md" - - source: "afb-tests-overview.md" - label : "afb basic test" - - source: "afb-daemon-vocabulary.md" - label : "afb vocabulary" diff --git a/site/_tocs/bindings/toc_dev_en.yml b/site/_tocs/bindings/toc_dev_en.yml deleted file mode 100644 index 1b4c7c0..0000000 --- a/site/_tocs/bindings/toc_dev_en.yml +++ /dev/null @@ -1,20 +0,0 @@ -# WARNING: -# - TOC should reference .HTML and .md (Index OK but Error 404) -# - do not forget to run 'docbuild --tocs' after any changes - -name: Bindings -template: generated_index.html -children: -- - name: Introduction - children: - - url: guide/overview/index.html -- - name: Application Framework - children: - - url: reference/ap/main/afm-system-daemon.html - - url: reference/ap/main/afm-user-daemon.html - - url: reference/ap/binder/afb-application-writing.html - - url: reference/ap/binder/afb-bindings-writing.html - - diff --git a/site/_tocs/getting_started/fetched_files.yml b/site/_tocs/getting_started/fetched_files.yml new file mode 100644 index 0000000..3dc750c --- /dev/null +++ b/site/_tocs/getting_started/fetched_files.yml @@ -0,0 +1,44 @@ +# REFERENCE 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 : "GITHUB_FETCH" +url_edit : "GITHUB_EDIT" +git_commit : "master" +#dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) + +repositories: +- + git_name : automotive-grade-linux/docs-agl + src_prefix : docs/getting-started + documents : + - source: source-code.md + label: Download AGL Source Code + - source: machines/qemu.md + label: Build for Qemu + - source: machines/porter.md + label: Build for Renesas Porter board + - source: machines/raspberrypi.md + label: Build for Raspberry PI 2/3 + - source: troubleshooting.md + label: Troubleshooting + - source: footers/porter-footer.md + label: Porter board + - source: footers/raspberrypi-footer.md + label: Rasperry PI + - source: images/RaspberryPi2-ModelB-debug-serial-cable.jpg + destination: footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpg + diff --git a/site/_tocs/getting_started/toc_dev_en.yml b/site/_tocs/getting_started/toc_dev_en.yml new file mode 100644 index 0000000..44bcfe8 --- /dev/null +++ b/site/_tocs/getting_started/toc_dev_en.yml @@ -0,0 +1,21 @@ +# WARNING: +# - TOC should reference .HTML and .md (Index OK but Error 404) +# - do not forget to run 'docbuild --tocs' after any changes + +name: Getting started +template: generated_index.html +children: +- + name: Getting Started + children: + - url: reference/source-code.html + - url: reference/machines/qemu.html + - url: reference/machines/porter.html + - url: reference/machines/raspberrypi.html +- + name: Known Issues + children: + - url: reference/troubleshooting.html + - url: reference/footers/porter-footer.html + - url: reference/footers/raspberrypi-footer.html + diff --git a/site/_tocs/hardware/fetched_files.yml b/site/_tocs/hardware/fetched_files.yml index 1d77012..1e0c4c7 100644 --- a/site/_tocs/hardware/fetched_files.yml +++ b/site/_tocs/hardware/fetched_files.yml @@ -21,25 +21,4 @@ git_commit : "master" #dst_prefix : # destination_path = destination_prefix + (document.destination || document.source) repositories: - -- - git_name : "apache/cordova-cli" - documents : - - - label: "cordova" - source: "doc/readme.md" - destination: "cordova-cli/index.md" -- - git_name: "apache/cordova-plugin-battery-status" - documents: - - - source: "README.md" - destination: "cordova-plugin-battery-status/index.md" - -- - git_name: "apache/cordova-plugin-camera" - documents: - - - source: "README.md" - destination: "cordova-plugin-camera/index.md" diff --git a/site/_tocs/hardware/toc_dev_en.yml b/site/_tocs/hardware/toc_dev_en.yml index e7c604e..ba0c41a 100644 --- a/site/_tocs/hardware/toc_dev_en.yml +++ b/site/_tocs/hardware/toc_dev_en.yml @@ -2,18 +2,8 @@ # - TOC should reference .HTML and .md (Index OK but Error 404) # - do not forget to run 'docbuild --tocs' after any changes -name: Hardware +name: Hardware Support template: generated_index.html children: -- - name: Introduction - children: - - url: guide/overview/index.html -- - name: Create application - children: - - url: reference/cordova-cli/index.html - - url: reference/cordova-plugin-battery-status/index.html - - url: reference/cordova-plugin-camera/index.html diff --git a/site/_tocs/quickstart/toc_dev_en.yml b/site/_tocs/quickstart/toc_dev_en.yml deleted file mode 100644 index fdc2990..0000000 --- a/site/_tocs/quickstart/toc_dev_en.yml +++ /dev/null @@ -1,19 +0,0 @@ -# WARNING: -# - TOC should reference .HTML and .md (Index OK but Error 404) -# - do not forget to run 'docbuild --tocs' after any changes - -name: Quickstart -template: generated_index.html -children: -- - name: Introduction - children: - - url: guide/overview/index.html -- - name: Create application - children: - - url: reference/cordova-cli/index.html - - url: reference/cordova-plugin-battery-status/index.html - - url: reference/cordova-plugin-camera/index.html - - |