############################################################################################################## # GLOBAL DOCUMENT # : 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: app-workflow-intro.md label: Overview - source: app-workflow-image.md label: Download or Build Your Image - source: app-workflow-sdk.md label: Download or Build Your SDK Installer - source: app-workflow-bootables.md label: Create Bootable Media - source: app-workflow-boot.md label: Boot the Image on the Board - source: app-workflow-prep-app.md label: Get Ready to Create Your Application - source: app-workflow-build-app.md label: Create and Build the Application - source: app-workflow-deploy-app.md label: Deploy the Application to the Board - source: app-workflow-debug-app.md label: Debug the Application - source: images/app-developer-workflow.png destination: images/app-developer-workflow.png - source: image-workflow-intro.md label: Overview - source: image-workflow-prep-host.md label: Preparing Your Build Host - source: image-workflow-download-sw.md label: Downloading AGL Software - source: image-workflow-initialize-build-environment.md label: Initializing Your Build Environment - source: image-workflow-cust-build.md label: Customizing Your Build - source: image-workflow-build.md label: Building the AGL Image - source: machines/intel.md label: Building for Most Intel 64-Bit Hardware Platforms - source: machines/qemu.md label: Building for Emulation - source: machines/renesas.md label: Building for Supported Renesas Boards - source: machines/raspberrypi.md label: Building for Raspberry PI 2 or 3 - source: images/image-developer-workflow.png destination: images/image-developer-workflow.png - source: troubleshooting.md label: Generic issues - source: footers/intel-footer.md label: Intel Boards - source: footers/raspberrypi-footer.md label: Raspberry PI - source: footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpg destination: footers/images/RaspberryPi2-ModelB-debug-serial-cable.jpg - source: docker-container-setup.md label: Setting Up a Docker Container - 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