aboutsummaryrefslogtreecommitdiffstats
path: root/content/tocs/getting_started/fetched_files.yml
blob: e1ea28b025683238661254dd114d969f9157e6b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
##############################################################################################################
# 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: getting-started-welcome.md
      label: Overview
    - 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: machines/images/RaspberryPi2-ModelB-debug-serial-cable.png
      destination: machines/images/RaspberryPi2-ModelB-debug-serial-cable.png
    - source: docker-container-setup.md
      label: Overview
-
    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