diff options
| author |   Johann CAHIER <johann.cahier@iot.bzh> | 2018-10-09 10:45:08 +0200 |
|---|---|---|
| committer | Johann CAHIER <johann.cahier@iot.bzh> | 2018-10-11 13:38:39 +0200 |
| commit | bbbe9c168526bbb729022f9de903aff5690b328d (patch) | |
| tree | e20b465e03d23d4c85a62dbfbc2aa1d8f8c13a4f /docs/part-2/1_xds-server | |
| parent | 48374d29bcc3bcf2b055b49d56eac49247772271 (diff) | |
Improves documentation
* Describes better available source tree sharing method (between
xds-agent and xds-server), and which to prefer depending on the
deployment setup.
* Gives indication about how to pass RSYNC_TARGET and RSYNC_PREFIX
env vars to the helloworld-native-application build process.
* Swap chapter order (build before config)
Change-Id: Ie4c22f277a59b0405744d71b0fadff67c5d5d025
Signed-off-by: Johann CAHIER <johann.cahier@iot.bzh>
Diffstat (limited to 'docs/part-2/1_xds-server')
| -rw-r--r-- | docs/part-2/1_xds-server/0_abstract.md | 7 | ||||
| -rw-r--r-- | docs/part-2/1_xds-server/1_build.md (renamed from docs/part-2/1_xds-server/3_build.md) | 0 | ||||
| -rw-r--r-- | docs/part-2/1_xds-server/2_config.md (renamed from docs/part-2/1_xds-server/1_config.md) | 0 | ||||
| -rw-r--r-- | docs/part-2/1_xds-server/3_how-to-run.md (renamed from docs/part-2/1_xds-server/2_how-to-run.md) | 4 |
4 files changed, 6 insertions, 5 deletions
diff --git a/docs/part-2/1_xds-server/0_abstract.md b/docs/part-2/1_xds-server/0_abstract.md index 07dd057..8e8d9a4 100644 --- a/docs/part-2/1_xds-server/0_abstract.md +++ b/docs/part-2/1_xds-server/0_abstract.md @@ -35,7 +35,8 @@ IDE (such as Netbeans or Visual Studio Code) through `xds-agent <=> xds-server`. Links to subchapters : -- [Configuration](./1_config.html) -- [How to run](./2_how-to-run.html) -- [Build from scratch](./3_build.html) +- [Build from scratch](./1_build.html) +- [Configuration](./2_config.html) +- [How to run](./3_how-to-run.html) - [Debugging](./4_debug.html) +- [Tests](./5_test.html) diff --git a/docs/part-2/1_xds-server/3_build.md b/docs/part-2/1_xds-server/1_build.md index 5c5059f..5c5059f 100644 --- a/docs/part-2/1_xds-server/3_build.md +++ b/docs/part-2/1_xds-server/1_build.md diff --git a/docs/part-2/1_xds-server/1_config.md b/docs/part-2/1_xds-server/2_config.md index ad86043..ad86043 100644 --- a/docs/part-2/1_xds-server/1_config.md +++ b/docs/part-2/1_xds-server/2_config.md diff --git a/docs/part-2/1_xds-server/2_how-to-run.md b/docs/part-2/1_xds-server/3_how-to-run.md index a3ae22b..4e56f3f 100644 --- a/docs/part-2/1_xds-server/2_how-to-run.md +++ b/docs/part-2/1_xds-server/3_how-to-run.md @@ -118,7 +118,7 @@ See also [xds-agent documentation](../2_xds-agent/0_abstract.html) for more deta <!-- end-section-note --> `xds-server` dynamically detects supported SDKs by scanning sub-directories of -`sdkScriptsDir` directory (see [Configuration chapter](1_config.html)). +`sdkScriptsDir` directory (see [Configuration chapter](2_config.html)). Each sub-directory (usually name is the same as the SDK family) of `sdkScriptsDir` must contain a set of scripts that will be called by `xds-server` to managed SDKs @@ -159,7 +159,7 @@ On startup `xds-server` will call in order: - `sdks/*/get-family-config` to get configuration of each SDK family. - `sdks/*/db-update` to update database (only when `SdkDbUpdate` is set to ̀`startup`, - see [Configuration chapter](1_config.html) for more details) + see [Configuration chapter](2_config.html) for more details) - `sdks/*/db-dump` scripts to get the initial list of available and installed SDKs. Please refer to `sdks/README.md` for more information about scripts definition |