aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--book.json10
-rw-r--r--docs/part-1/2_install-xds-server.md6
-rw-r--r--docs/part-1/4_build-first-app.md5
-rw-r--r--docs/part-1/5_debug-first-app.md2
-rw-r--r--docs/part-2/1_xds-server.md19
-rw-r--r--docs/part-2/2_xds-agent.md8
-rw-r--r--docs/resources/ebook.css16
7 files changed, 49 insertions, 17 deletions
diff --git a/book.json b/book.json
index 1f6efb9..dee1ed5 100644
--- a/book.json
+++ b/book.json
@@ -62,6 +62,16 @@
"substitute": "</div>"
},
{
+ "pattern": "<!-- warning -->",
+ "flags": "g",
+ "substitute": "<div class=\"warning\">"
+ },
+ {
+ "pattern": "<!-- endwarning -->",
+ "flags": "g",
+ "substitute": "</div>"
+ },
+ {
"pattern": "!\\[(.*?)\\]\\((.*?)(?:\\s+\"(.*)\")?\\){0,}{caption=1([^\\}]*)}",
"flags": "gmi",
"substitute": "<figure id=\"fig_PAGE_LEVEL_._INDEX_\"><img $3 alt=\"$1\" title=\"$1\" href=\"$2\"><figcaption></figcaption></figure>",
diff --git a/docs/part-1/2_install-xds-server.md b/docs/part-1/2_install-xds-server.md
index 8f3d36c..eb9e631 100644
--- a/docs/part-1/2_install-xds-server.md
+++ b/docs/part-1/2_install-xds-server.md
@@ -141,7 +141,7 @@ are set into `/etc/default/xds-server` file.
and default JSON config is `/etc/xds-server/config.json`.
<!-- note -->
->**Note**: you can use your own JSON config by settings `APP_CONFIG` variable of
+>**Note:** you can use your own JSON config by settings `APP_CONFIG` variable of
`/etc/default/xds-server` file to your file, for example
`/home/MYUSER/.xds/server/config.json`
<!-- endnote -->
@@ -155,7 +155,7 @@ Supported fields in JSON configuration file are :
- **sdkRootDir** : root directory where cross SDKs are installed
- **syncthing.binDir** : syncthing binaries directory (default: executable directory)
- **syncthing.home"** : syncthing home directory (usually .../syncthing-config)
-- **syncthing.gui-address** : syncthing gui url (default http://localhost:8384)
+- **syncthing.gui-address** : syncthing gui url (default <http://localhost:8384>)
- **syncthing.gui-apikey** : syncthing api-key to use (default auto-generated)
All fields are optional and example below corresponds to the default values:
@@ -176,7 +176,7 @@ All fields are optional and example below corresponds to the default values:
}
```
->**NOTE:** environment variables are supported by using `${MY_VAR}` syntax.
+>**Note:** environment variables are supported by using `${MY_VAR}` syntax.
### Start/Stop xds-server
diff --git a/docs/part-1/4_build-first-app.md b/docs/part-1/4_build-first-app.md
index 342113d..cc3b35e 100644
--- a/docs/part-1/4_build-first-app.md
+++ b/docs/part-1/4_build-first-app.md
@@ -10,7 +10,7 @@ Depending of the project sharing method:
- Path mapping: you must clone project into `$HOME/xds-workspace` directory.
<!-- note -->
-> **Note** : [helloworld-native-application](https://github.com/iotbzh/helloworld-native-application) project is an AGL
+> **Note:** : [helloworld-native-application](https://github.com/iotbzh/helloworld-native-application) project is an AGL
project based on [app-templates](https://git.automotivelinux.org/apps/app-templates/)
(included as a git submodule). This CMake templating, used to develop application
with the AGL Application Framework, will automatically generate makefile rules
@@ -268,7 +268,8 @@ And define your own tasks, here is an example to build [unicens2-binding](https:
}
```
-> **NOTE** You can also add your own keybindings to trig above tasks, for example:
+> **Note:** You can also add your own keybindings to trig above tasks, for example:
+>
> ```json
> // Build
> {
diff --git a/docs/part-1/5_debug-first-app.md b/docs/part-1/5_debug-first-app.md
index cc0e8a2..15f58b9 100644
--- a/docs/part-1/5_debug-first-app.md
+++ b/docs/part-1/5_debug-first-app.md
@@ -146,7 +146,7 @@ xds-gdb -x target/gdb-on-root@myTarget.ini
```
<!-- note -->
-> **Note** : [helloworld-native-application](https://github.com/iotbzh/helloworld-native-application) project is an AGL
+> **Note:** : [helloworld-native-application](https://github.com/iotbzh/helloworld-native-application) project is an AGL
project based on [app-templates](https://git.automotivelinux.org/apps/app-templates/)
(included as a git submodule). This CMake templating, used to develop application
with the AGL Application Framework, will automatically generate makefile rules
diff --git a/docs/part-2/1_xds-server.md b/docs/part-2/1_xds-server.md
index 6fc5779..eb4bb17 100644
--- a/docs/part-2/1_xds-server.md
+++ b/docs/part-2/1_xds-server.md
@@ -26,7 +26,7 @@ IDE (such as Netbeans or Visual Studio Code) through `xds-server`.
[AGL](https://www.automotivelinux.org/) applications. That's why `xds-server` has
been integrated into AGL SDK docker container.
->**NOTE** For more info about AGL SDK docker container, please refer to
+>**Note:** For more info about AGL SDK docker container, please refer to
[AGL SDK Quick Setup](http://docs.automotivelinux.org/docs/getting_started/en/dev/reference/setup-sdk-environment.html)
### Get the container
@@ -240,14 +240,19 @@ And to install `xds-server` (by default in `/opt/AGL/xds/server`):
make install
```
->**WARNING:** makefile install rule and default values in configuration file are set
- to fit the docker setup, so you may need to adapt some settings when you want to install
- xds-server natively.
+<!-- warning -->
+>**Warning:** makefile install rule and default values in configuration file are set
+> to fit the docker setup, so you may need to adapt some settings when you want to install
+> xds-server natively.
+<!-- endwarning -->
->**NOTE:** Used `DESTDIR` to specify another install directory
+<!-- note -->
+>**Note:** Used `DESTDIR` to specify another install directory
+>
>```bash
>make install DESTDIR=$HOME/opt/xds-server
>```
+<!-- endnote -->
#### XDS docker image
@@ -284,7 +289,7 @@ below corresponds to the default values):
- **sdkRootDir** : root directory where cross SDKs are installed
- **syncthing.binDir** : syncthing binaries directory (default: executable directory)
- **syncthing.home"** : syncthing home directory (usually .../syncthing-config)
-- **syncthing.gui-address** : syncthing gui url (default http://localhost:8384)
+- **syncthing.gui-address** : syncthing gui url (default <http://localhost:8384>)
- **syncthing.gui-apikey** : syncthing api-key to use (default auto-generated)
```json
@@ -303,7 +308,7 @@ below corresponds to the default values):
}
```
->**NOTE:** environment variables are supported by using `${MY_VAR}` syntax.
+>**Note:** environment variables are supported by using `${MY_VAR}` syntax.
## Debugging
diff --git a/docs/part-2/2_xds-agent.md b/docs/part-2/2_xds-agent.md
index c66d50f..7d6658e 100644
--- a/docs/part-2/2_xds-agent.md
+++ b/docs/part-2/2_xds-agent.md
@@ -46,7 +46,7 @@ below corresponds to the default values):
}
```
->**NOTE:** environment variables are supported by using `${MY_VAR}` syntax.
+>**Note:** environment variables are supported by using `${MY_VAR}` syntax.
## Start-up
@@ -56,7 +56,7 @@ Simply to start `xds-agent` executable
./xds-agent &
```
->**NOTE** if need be, you can increase log level by setting option
+>**Note:** if need be, you can increase log level by setting option
`--log <level>`, supported *level* are: panic, fatal, error, warn, info, debug.
You can now use XDS dashboard and check that connection with `xds-agent` is up.
@@ -69,7 +69,7 @@ You can now use XDS dashboard and check that connection with `xds-agent` is up.
Install and setup [Go](https://golang.org/doc/install) version 1.8 or
higher to compile this tool.
->**NOTE:** for Ubuntu, you can use a PPA, see [https://github.com/golang/go/wiki/Ubuntu](https://github.com/golang/go/wiki/Ubuntu)
+>**Note:** for Ubuntu, you can use a PPA, see [https://github.com/golang/go/wiki/Ubuntu](https://github.com/golang/go/wiki/Ubuntu)
### Building
@@ -89,7 +89,7 @@ And to install xds-agent (by default in `/usr/local/bin`):
make install
```
->**NOTE:** Used `DESTDIR` to specify another install directory
+>**Note:** Used `DESTDIR` to specify another install directory
>```bash
>make install DESTDIR=$HOME/opt/xds-agent
>```
diff --git a/docs/resources/ebook.css b/docs/resources/ebook.css
index 39f126c..e8df4d8 100644
--- a/docs/resources/ebook.css
+++ b/docs/resources/ebook.css
@@ -70,6 +70,22 @@ div.note p {
margin-bottom: 0;
}
+/* warning blocks */
+
+div.warning {
+ background: #FD9595 none repeat scroll 0% 0%;
+ color: #8A6D3B;
+ padding: 15px;
+ margin-bottom: 10px;
+ border-bottom: 5px solid #DDD;
+ border-color: #FF6B6B;
+ page-break-inside: avoid;
+}
+
+div.warning p {
+ padding-bottom: 0;
+ margin-bottom: 0;
+}
/* images, figures and captions */