diff options
Diffstat (limited to 'docs/part-2')
| -rw-r--r-- | docs/part-2/1_xds-server.md | 19 | ||||
| -rw-r--r-- | docs/part-2/2_xds-agent.md | 8 |
2 files changed, 16 insertions, 11 deletions
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 >``` |