diff options
Diffstat (limited to 'docs/part-2')
| -rw-r--r-- | docs/part-2/1_xds-server/1_config.md | 8 | ||||
| -rw-r--r-- | docs/part-2/1_xds-server/2_how-to-run.md | 12 | ||||
| -rw-r--r-- | docs/part-2/1_xds-server/3_build.md | 8 | ||||
| -rw-r--r-- | docs/part-2/2_xds-agent/2_start.md | 4 | ||||
| -rw-r--r-- | docs/part-2/3_xds-cli/1_config.md | 4 | ||||
| -rw-r--r-- | docs/part-2/3_xds-cli/2_commands.md | 4 |
6 files changed, 20 insertions, 20 deletions
diff --git a/docs/part-2/1_xds-server/1_config.md b/docs/part-2/1_xds-server/1_config.md index 594bdf2..fc82807 100644 --- a/docs/part-2/1_xds-server/1_config.md +++ b/docs/part-2/1_xds-server/1_config.md @@ -50,11 +50,11 @@ are set into `/etc/default/xds-server` file. `xds-server` configuration is also driven by a JSON config file (`server-config.json`), and default JSON config is `/etc/xds/server/server-config.json`. -<!-- note --> +<!-- section-note --> **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/server-config.json` -<!-- endnote --> +<!-- end-section-note --> ## Disable syncthing @@ -78,9 +78,9 @@ Here is a JSON configuration file example where syncthing key as been renamed: On benefit to do that is to increase XDS-Server startup time. -<!-- note --> +<!-- section-note --> **Note:** - `CloudSync` (AKA syncthing) synchronization type can also be disabled when `"syncthing"` key is not defined in JSON configuration file. -<!-- endnote --> +<!-- end-section-note --> diff --git a/docs/part-2/1_xds-server/2_how-to-run.md b/docs/part-2/1_xds-server/2_how-to-run.md index 5ca8d28..8c6aa55 100644 --- a/docs/part-2/1_xds-server/2_how-to-run.md +++ b/docs/part-2/1_xds-server/2_how-to-run.md @@ -77,21 +77,21 @@ On **Windows**, simply execute `xds-server` executable: C:\AGL\bin\xds-server.exe ``` -<!-- note --> +<!-- section-note --> **Note:** Invoke `xds-server --help` to get more details about possible options that allow for example to change logging level or select another configuration file. -<!-- endnote --> +<!-- end-section-note --> ## SDK cross-toolchain Management ### Setup to add support of a new SDK family -<!-- note --> +<!-- section-note --> **Optional step**: read this chapter only if you plan to add a new SDK family. -<!-- endnote --> +<!-- end-section-note --> `xds-server` dynamically detects supported SDKs by scanning sub-directories of `sdkScriptsDir` directory (see [Configuration chapter](1_config.html)). @@ -199,10 +199,10 @@ xds-cli sdks install --file $HOME/xds-workspace/sdks/poky-agl-glibc-x86_64-agl-d ``` -<!-- note --> +<!-- section-note --> Installation based on a local SDK package is only supported when SDK file package is located in `$HOME/xds-workspace/sdks` directory -<!-- endnote --> +<!-- end-section-note --> ### Install a new SDK from XDS Dashboard diff --git a/docs/part-2/1_xds-server/3_build.md b/docs/part-2/1_xds-server/3_build.md index 8be3b33..92a90ea 100644 --- a/docs/part-2/1_xds-server/3_build.md +++ b/docs/part-2/1_xds-server/3_build.md @@ -36,16 +36,16 @@ And to install `xds-server` (by default in `/opt/AGL/xds/server`): make install ``` -<!-- warning --> +<!-- section-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 --> +<!-- end-section-warning --> -<!-- note --> +<!-- section-note --> **Note:** Used `DESTDIR` to specify another install directory @@ -54,7 +54,7 @@ Used `DESTDIR` to specify another install directory make install DESTDIR=$HOME/opt/xds-server ``` -<!-- endnote --> +<!-- end-section-note --> ### XDS docker image diff --git a/docs/part-2/2_xds-agent/2_start.md b/docs/part-2/2_xds-agent/2_start.md index 7d6735d..c537c93 100644 --- a/docs/part-2/2_xds-agent/2_start.md +++ b/docs/part-2/2_xds-agent/2_start.md @@ -40,7 +40,7 @@ depending where you installed/unzipped xds-agent tarball): C:\AGL\bin\xds-agent.exe ``` -<!-- note --> +<!-- section-note --> **Note:** If need be, you can increase log level by setting option @@ -49,4 +49,4 @@ If need be, you can increase log level by setting option Invoke `xds-agent --help` to get more details about possible options that allow for example to change logging level or select a specific configuration file. -<!-- endnote --> +<!-- end-section-note --> diff --git a/docs/part-2/3_xds-cli/1_config.md b/docs/part-2/3_xds-cli/1_config.md index 6dc7993..82506ee 100644 --- a/docs/part-2/3_xds-cli/1_config.md +++ b/docs/part-2/3_xds-cli/1_config.md @@ -16,12 +16,12 @@ options or using a config file knowing that the following priority order is used config file is specified with `--config|-c` option, 1. else use `XDS_xxx` (for example `XDS_PROJECT_ID`) environment variable -<!-- note --> +<!-- section-note --> **Note:** All parameters after a double dash (--) are considered as the command to execute on xds-server. -<!-- endnote --> +<!-- end-section-note --> ## Global Options / Configuration variables diff --git a/docs/part-2/3_xds-cli/2_commands.md b/docs/part-2/3_xds-cli/2_commands.md index b5e0c0a..599906c 100644 --- a/docs/part-2/3_xds-cli/2_commands.md +++ b/docs/part-2/3_xds-cli/2_commands.md @@ -51,12 +51,12 @@ xds-cli sdks ls xds-cli sdks get c64d ``` -<!-- note --> +<!-- section-note --> **Note:** Please also refer to [Installing AGL SDKs](../../part-1/3_install-sdks.html) chapter for more details about sdks installation. -<!-- endnote --> +<!-- end-section-note --> ## exec |