aboutsummaryrefslogtreecommitdiffstats
path: root/content/tocs/devguides/toc_dev_en.yml
blob: f9bad98e5489594bda3ab26b3af3cc7f06ed6b8d (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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
#######################################################################
# WARNING:
#  - TOC should reference .HTML and .md (Index OK but Error 404)
#  - do not forget to run 'docbuild --tocs' after any changes
#
#
############################ SYNTAX ###################################
# GLOBAL OPTIONS:
#    name: TOC (page) title
#    template: name of template to use for this page - use 'generated_index.html' if unknown
#    children: array of TOC entries
#
# 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:
#         -
#            name: ...
#            url: ...
#         ...
#
# EXAMPLE:
# -------------------------------
# name: Developer Guides
# template: generated_index.html
# children:
# -
#   name: Application Framework
#   children:
#       - url: reference/af-main/overview.html
#       - url: reference/af-main/afm-system-daemon.html
#       - url: reference/af-main/afm-user-daemon.html
# -------------------------------
#######################################################################

name: Developer Guides
template: generated_index.html
children:
-
    name: AGL layers
    children:
        - url: reference/AGL.html
        - url: reference/meta-agl.html
        - url: reference/meta-agl-demo.html
        - url: reference/meta-agl-devel.html
-
    name: Host Configuration
    children:
        -
            name: Abstract
            url: reference/host-configuration/docs/0_Abstract.html
        -
            name: Prerequisites
            url: reference/host-configuration/docs/1_Prerequisites.html
        -
            name: AGL Application Framework
            url: reference/host-configuration/docs/2_AGL_Application_Framework.html
        -
            name: Binding Build Example
            url: reference/host-configuration/docs/3_Binding_Build_Example.html
        -
            name: AGL XDS
            url: reference/host-configuration/docs/4_AGL_XDS.html
        -
            name: CanDevStudio
            url: reference/host-configuration/docs/5_Candevstudio.html
-
    name: "Usage of CMake Afb Template module"
    children:
        -
            name: "Abstract"
            url: "reference/cmakeafbtemplates/0_Abstract.html"
        -
            name: "Quickstart"
            url: "reference/cmakeafbtemplates/1_Quickstart.html"
        -
            name: "Project architecture"
            url: "reference/cmakeafbtemplates/2_project_architecture.html"
        -
            name: "Advanced usage"
            url: "reference/cmakeafbtemplates/3_advanced_usage.html"
        -
            name: "Advanced customization"
            url: "reference/cmakeafbtemplates/4_advanced_customization.html"
        -
            name: "The autobuild script"
            url: "reference/cmakeafbtemplates/5_autobuild.html"
-
    name: "X(cross) Development System: User's Guide"
    children:
        -
          name: Getting Started
          url: reference/xds/part-1/0_Abstract.html
        -
          name: Installing xds-server
          children:
              -
                name: Installation
                url: reference/xds/part-1/1_install-xds-server.html
              -
                name: Based on Docker container
                url: reference/xds/part-1/1-1_install-xds-server-docker.html
              -
                name: Based on Virtual Machine appliance
                url: reference/xds/part-1/1-2_install-xds-server-vm.html
              -
                name: Native installation
                url: reference/xds/part-1/1-3_install-xds-server-native.html
        -
          name: Installing xds client tools
          url: reference/xds/part-1/2_install-client.html
        -
          name: Installing AGL SDKs
          url: reference/xds/part-1/3_install-sdks.html
        -
          name: Create your first AGL application
          children:
              -
                name: Prerequisites
                url: reference/xds/part-1/4_build-first-app.html
              -
                name: Setup
                url: reference/xds/part-1/4-1_build-first-app-setup.html
              -
                name: Build using command line tool
                url: reference/xds/part-1/4-2_build-first-app-cmd.html
              -
                name: Build using XDS Dashboard
                url: reference/xds/part-1/4-3_build-first-app-dashboard.html
              -
                name: Build using a source code editor / IDE
                url: reference/xds/part-1/4-4_build-first-app-ide.html
        -
          name: Debug your first AGL application
          children:
              -
                name: Prerequisites
                url: reference/xds/part-1/5_debug-first-app.html
              -
                name: Configuration
                url: reference/xds/part-1/5-1_debug-first-app-config.html
              -
                name: xds-gdb from command line
                url: reference/xds/part-1/5-2_debug-first-app-cmd.html
              -
                name: xds-gdb within an IDE
                url: reference/xds/part-1/5-3_debug-first-app-ide.html

-
    name: "X(cross) Development System: Internals"
    children:
        -
          name: Abstract
          url: reference/xds/part-2/0_Abstract.html
        -
          name: Prerequisites
          url: reference/xds/part-2/1_Prerequisites.html
        -
          name: XDS-server
          children:
              -
                name: Abstract
                url: reference/xds/part-2/1_xds-server/0_abstract.html
              -
                name: Build from scratch
                url: reference/xds/part-2/1_xds-server/1_build.html
              -
                name: Configuration
                url: reference/xds/part-2/1_xds-server/2_config.html
              -
                name: How to run
                url: reference/xds/part-2/1_xds-server/3_how-to-run.html
              -
                name: Debugging
                url: reference/xds/part-2/1_xds-server/4_debug.html
              -
                name: Test
                url: reference/xds/part-2/1_xds-server/5_test.html
        -
          name: XDS-agent
          children:
              -
                name: Abstract
                url: reference/xds/part-2/2_xds-agent/0_abstract.html
              -
                name: Build from scratch
                url: reference/xds/part-2/2_xds-agent/1_build.html
              -
                name: Configuration
                url: reference/xds/part-2/2_xds-agent/2_config.html
              -
                name: Start
                url: reference/xds/part-2/2_xds-agent/3_start.html
              -
                name: Debugging
                url: reference/xds/part-2/2_xds-agent/4_debug.html
        -
          name: XDS-cli
          children:
              -
                name: Abstract
                url: reference/xds/part-2/3_xds-cli/0_abstract.html
              -
                name: Build from scratch
                url: reference/xds/part-2/3_xds-cli/1_build.html
              -
                name: Configuration
                url: reference/xds/part-2/3_xds-cli/2_config.html
              -
                name: CLI Commands
                url: reference/xds/part-2/3_xds-cli/3_commands.html
              -
                name: Debugging
                url: reference/xds/part-2/3_xds-cli/4_debug.html
        -
          name: XDS-gdb
          children:
              -
                name: Abstract
                url: reference/xds/part-2/4_xds-gdb/0_abstract.html
              -
                name: Build from scratch
                url: reference/xds/part-2/4_xds-gdb/1_build.html
              -
                name: Configuration
                url: reference/xds/part-2/4_xds-gdb/2_config.html
              -
                name: Debugging
                url: reference/xds/part-2/4_xds-gdb/3_debug.html
-
    name: Guides
    children:
        -
            name: AppFW - Privileges Management
            url: reference/iotbzh2016/appfw/03-AGL-AppFW-Privileges-Management.pdf

-
    name: Controller Guide
    children:
          - url: reference/ctrler/controller.html
          - url: reference/ctrler/controllerConfig.html
          - url: reference/ctrler/Usage.html
          - url: reference/ctrler/configSample.html

-
    name: "Continuous Integration - Automated Testing (CIAT)"
    children:
        -
            name: Training
            children:
                -
                    name:  "How to write tests (overview slides)"
                    url: reference/CIAT/training/How_to_write_your_own_tests_for_AGL.pdf
                -
                    name:  "How to write tests (detailed)"
                    url: reference/CIAT/training/Hands_on_lab_documentation.pdf