diff options
Diffstat (limited to 'content/tocs/getting_started')
-rw-r--r-- | content/tocs/getting_started/fetched_files.yml | 92 | ||||
-rw-r--r-- | content/tocs/getting_started/section_flounder.yml | 17 | ||||
-rw-r--r-- | content/tocs/getting_started/section_guppy.yml | 17 | ||||
-rw-r--r-- | content/tocs/getting_started/section_master.yml | 17 | ||||
-rw-r--r-- | content/tocs/getting_started/toc_dev_en.yml | 47 |
5 files changed, 85 insertions, 105 deletions
diff --git a/content/tocs/getting_started/fetched_files.yml b/content/tocs/getting_started/fetched_files.yml deleted file mode 100644 index ba1fafe..0000000 --- a/content/tocs/getting_started/fetched_files.yml +++ /dev/null @@ -1,92 +0,0 @@ -############################################################################################################## -# 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 -# ------------------------------------ -############################################################################################################## - -#dst_prefix: # destination_path = destination_prefix + (document.destination || document.source) - -url_fetch: GERRIT_FETCH -git_commit: AGL_GERRIT_BRANCH - -repositories: -- - url_fetch: AGL_GITHUB_FETCH - url_edit: AGL_GITHUB_EDIT - git_name: automotive-grade-linux/docs-sources - git_commit: AGL_GITHUB_BRANCH - src_prefix: docs/getting-started - documents: - - source: source-code.md - label: Download AGL Source Code - - source: customize_bitbake_conf.md - label: Customize the AGL build - - source: machines/intel.md - label: Build for Intel - - source: machines/qemu.md - label: Build for Qemu - - source: machines/R-Car-Starter-Kit-gen3.md - label: Build for R Car Starter Kit gen3 board - - source: machines/raspberrypi.md - label: Build for Raspberry PI 2/3 - - source: troubleshooting.md - label: Generic issues - - source: footers/intel-footer.md - label: Intel Boards - - source: footers/raspberrypi-footer.md - label: Raspberry PI - - source: images/RaspberryPi2-ModelB-debug-serial-cable.jpg - destination: footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpg - - source: setup-sdk-environment.md - label: SDK Quick Setup -- - git_name: apps/homescreen - src_prefix: homescreen/docs - dst_prefix: homescreen - documents: - - source: index.md - label: Overview - - source: pictures/dashboard.png - destination: pictures/dashboard.png - - source: pictures/homescreen_applauncher.png - destination: pictures/homescreen_applauncher.png - - source: pictures/hvac.png - destination: pictures/hvac.png - - source: pictures/phone.png - destination: pictures/phone.png - - source: pictures/settings.png - destination: pictures/settings.png - diff --git a/content/tocs/getting_started/section_flounder.yml b/content/tocs/getting_started/section_flounder.yml new file mode 100644 index 0000000..51644bf --- /dev/null +++ b/content/tocs/getting_started/section_flounder.yml @@ -0,0 +1,17 @@ +url_fetch : "GERRIT_FETCH" + +name: Getting started +template: generated_index.html +books: +- + id: flounder-image-development-workflow + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + path: docs/getting-started-book.yml +- + id: flounder-apps-homescreen + url_fetch: GERRIT_FETCH + git_name: apps/homescreen + dst_prefix: homescreen + path: homescreen/docs/homescreen-book.yml diff --git a/content/tocs/getting_started/section_guppy.yml b/content/tocs/getting_started/section_guppy.yml new file mode 100644 index 0000000..4777c8d --- /dev/null +++ b/content/tocs/getting_started/section_guppy.yml @@ -0,0 +1,17 @@ +url_fetch : "GERRIT_FETCH" + +name: Getting started +template: generated_index.html +books: +- + id: image-development-workflow + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + path: docs/getting-started-book.yml +- + id: apps-homescreen + url_fetch: GERRIT_FETCH + git_name: apps/homescreen + dst_prefix: homescreen + path: homescreen/docs/homescreen-book.yml diff --git a/content/tocs/getting_started/section_master.yml b/content/tocs/getting_started/section_master.yml new file mode 100644 index 0000000..4777c8d --- /dev/null +++ b/content/tocs/getting_started/section_master.yml @@ -0,0 +1,17 @@ +url_fetch : "GERRIT_FETCH" + +name: Getting started +template: generated_index.html +books: +- + id: image-development-workflow + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + path: docs/getting-started-book.yml +- + id: apps-homescreen + url_fetch: GERRIT_FETCH + git_name: apps/homescreen + dst_prefix: homescreen + path: homescreen/docs/homescreen-book.yml diff --git a/content/tocs/getting_started/toc_dev_en.yml b/content/tocs/getting_started/toc_dev_en.yml index a534c61..8251337 100644 --- a/content/tocs/getting_started/toc_dev_en.yml +++ b/content/tocs/getting_started/toc_dev_en.yml @@ -1,9 +1,9 @@ ####################################################################### -# WARNING: +# WARNING: # - TOC should reference .HTML and .md (Index OK but Error 404) -# - do not forget to run 'docbuild --tocs' after any changes +# - do not forget to run 'docbuild --tocs' after any changes +# # -# ############################ SYNTAX ################################### # GLOBAL OPTIONS: # name: TOC (page) title @@ -13,7 +13,7 @@ # 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: # - @@ -39,13 +39,21 @@ name: Getting started template: generated_index.html children: - - name: Getting Started + name: Welcome! + children: + - url: reference/getting-started-welcome.html +- + name: Developing an AGL Image children: - - url: reference/source-code.html - - url: reference/customize_bitbake_conf.html + - url: reference/image-workflow-intro.html + - url: reference/image-workflow-prep-host.html + - url: reference/image-workflow-download-sw.html + - url: reference/image-workflow-initialize-build-environment.html + - url: reference/image-workflow-cust-build.html + - url: reference/image-workflow-build.html - url: reference/machines/intel.html - url: reference/machines/qemu.html - - url: reference/machines/R-Car-Starter-Kit-gen3.html + - url: reference/machines/renesas.html - url: reference/machines/raspberrypi.html - name: HomeScreen @@ -55,10 +63,23 @@ children: name: Troubleshooting children: - url: reference/troubleshooting.html - - url: reference/footers/intel-footer.html - - url: reference/footers/raspberrypi-footer.html - - name: SDK + name: Setting Up a Docker Container children: - - url: reference/setup-sdk-environment.html - + - url: reference/docker-container-setup.html +- +# name: Scott's new section so far +# children: +# - url: reference/scott.html +#- + name: Developing an Application + children: + - url: reference/app-workflow-intro.html + - url: reference/app-workflow-image.html + - url: reference/app-workflow-sdk.html + - url: reference/app-workflow-bootables.html + - url: reference/app-workflow-boot.html + - url: reference/app-workflow-prep-app.html + - url: reference/app-workflow-build-app.html + - url: reference/app-workflow-deploy-app.html + - url: reference/app-workflow-debug-app.html |