diff options
author | Patrick Vacek <patrickvacek@gmail.com> | 2019-10-16 15:17:10 +0200 |
---|---|---|
committer | Patrick Vacek <patrickvacek@gmail.com> | 2019-10-21 12:13:26 +0200 |
commit | b207592b3b679f869857b9edea81b1925e62692b (patch) | |
tree | b93c194620a55aa79b7428a97c248fc626bb4372 /README.adoc | |
parent | 7727e1e03ed4b26a5b4af6a89ccb9fed63b33ed4 (diff) | |
download | meta-updater-b207592b3b679f869857b9edea81b1925e62692b.tar.gz |
README: Point docs at the dev guide in the portal.
As opposed to the source of the docs in the aktualizr repo.
Signed-off-by: Patrick Vacek <patrickvacek@gmail.com>
Diffstat (limited to 'README.adoc')
-rw-r--r-- | README.adoc | 28 |
1 files changed, 12 insertions, 16 deletions
diff --git a/README.adoc b/README.adoc index e4ae3e6..4cccc7b 100644 --- a/README.adoc +++ b/README.adoc | |||
@@ -1,7 +1,7 @@ | |||
1 | = meta-updater | 1 | = meta-updater |
2 | :toc: macro | 2 | :toc: macro |
3 | :toc-title: | 3 | :toc-title: |
4 | :aktualizr-docsroot: https://github.com/advancedtelematic/aktualizr/tree/master/docs/ota-client-guide/modules/ROOT/pages/ | 4 | :devguide-docsroot: https://docs.ota.here.com/ota-client/latest/ |
5 | :getstarted-docsroot: https://docs.ota.here.com/getstarted/dev/ | 5 | :getstarted-docsroot: https://docs.ota.here.com/getstarted/dev/ |
6 | 6 | ||
7 | Meta-updater is a link:https://www.yoctoproject.org/software-overview/layers/[Yocto layer] that enables over-the-air updates (OTA) with https://github.com/ostreedev/ostree[OSTree] and https://github.com/advancedtelematic/aktualizr[Aktualizr] -- the default client for link:https://www.here.com/products/automotive/ota-technology[HERE OTA Connect]. | 7 | Meta-updater is a link:https://www.yoctoproject.org/software-overview/layers/[Yocto layer] that enables over-the-air updates (OTA) with https://github.com/ostreedev/ostree[OSTree] and https://github.com/advancedtelematic/aktualizr[Aktualizr] -- the default client for link:https://www.here.com/products/automotive/ota-technology[HERE OTA Connect]. |
@@ -31,45 +31,41 @@ sudo apt install ovmf | |||
31 | [discrete] | 31 | [discrete] |
32 | == Table of Contents | 32 | == Table of Contents |
33 | 33 | ||
34 | The following documentation focuses on tasks that involve the meta-updater layer. If you want to get an idea of the overall developer workflow in OTA Connect, see the link:https://docs.ota.here.com/ota-client/dev/index.html[OTA Connect Developer Guide]. | 34 | The following documentation focuses on tasks that involve the meta-updater layer. If you want to get an idea of the overall developer workflow in OTA Connect, see the link:{devguide-docsroot}index.html[OTA Connect Developer Guide]. |
35 | [NOTE] | ||
36 | ==== | ||
37 | The following links point to files in the aktualizr repository where the source of the developer guide is stored. | ||
38 | ==== | ||
39 | 35 | ||
40 | * xref:{aktualizr-docsroot}supported-boards.adoc[Supported boards] | 36 | * xref:{devguide-docsroot}supported-boards.html[Supported boards] |
41 | + | 37 | + |
42 | Find out if your board is supported and learn about the minimum hardware requirements. | 38 | Find out if your board is supported and learn about the minimum hardware requirements. |
43 | + | 39 | + |
44 | * xref:{aktualizr-docsroot}build-agl.adoc[Build an Automotive Grade Linux image] | 40 | * xref:{devguide-docsroot}build-agl.html[Build an Automotive Grade Linux image] |
45 | + | 41 | + |
46 | Learn how to use this layer as part of AGL. | 42 | Learn how to use this layer as part of AGL. |
47 | + | 43 | + |
48 | * xref:{aktualizr-docsroot}add-ota-functonality-existing-yocto-project.adoc[Add OTA functionality to an existing Yocto project] | 44 | * xref:{devguide-docsroot}add-ota-functonality-existing-yocto-project.html[Add OTA functionality to an existing Yocto project] |
49 | + | 45 | + |
50 | Learn how to add this layer to your own Yocto project. | 46 | Learn how to add this layer to your own Yocto project. |
51 | + | 47 | + |
52 | * xref:{aktualizr-docsroot}build-configuration.adoc[SOTA-related variables in local.conf] | 48 | * xref:{devguide-docsroot}build-configuration.html[SOTA-related variables in local.conf] |
53 | + | 49 | + |
54 | Learn how to configure OTA-related functionality when building images, including how to install custom versions of aktualizr. | 50 | Learn how to configure OTA-related functionality when building images, including how to install custom versions of aktualizr. |
55 | + | 51 | + |
56 | * xref:{aktualizr-docsroot}recommended-clientconfig.adoc[Recommended configuration] | 52 | * xref:{devguide-docsroot}recommended-clientconfig.html[Recommended configuration] |
57 | + | 53 | + |
58 | Learn how to optimize your build for development or production. | 54 | Learn how to optimize your build for development or production. |
59 | + | 55 | + |
60 | * xref:{aktualizr-docsroot}client-provisioning-methods.adoc[Provisoning methods] | 56 | * xref:{devguide-docsroot}client-provisioning-methods.html[Provisoning methods] |
61 | + | 57 | + |
62 | Learn more about the methods for provisioning devices. For more detail, you may also want to read about how to xref:{aktualizr-docsroot}enable-device-cred-provisioning.adoc[enable device credential provisioning] or how to xref:{aktualizr-docsroot}simulate-device-cred-provtest.adoc[simulate it for testing]. | 58 | Learn more about the methods for provisioning devices. For more detail, you may also want to read about how to xref:{devguide-docsroot}enable-device-cred-provisioning.html[enable device credential provisioning] or how to xref:{devguide-docsroot}simulate-device-cred-provtest.html[simulate it for testing]. |
63 | + | 59 | + |
64 | * xref:{aktualizr-docsroot}meta-updater-usage.adoc[Advanced usage] | 60 | * xref:{devguide-docsroot}meta-updater-usage.html[Advanced usage] |
65 | + | 61 | + |
66 | Learn about the `garage-push` and `garage-sign` utilities, aktualizr configuration recipes, and service resource control. | 62 | Learn about the `garage-push` and `garage-sign` utilities, aktualizr configuration recipes, and service resource control. |
67 | + | 63 | + |
68 | * xref:{aktualizr-docsroot}meta-updater-testing.adoc[Testing with oe-selftest and ptest] | 64 | * xref:{devguide-docsroot}meta-updater-testing.html[Testing with oe-selftest and ptest] |
69 | + | 65 | + |
70 | Learn how to use the `oe-selftest` framework for quality assurance and how to run the aktualizr test suite via ptest. | 66 | Learn how to use the `oe-selftest` framework for quality assurance and how to run the aktualizr test suite via ptest. |
71 | + | 67 | + |
72 | * xref:{aktualizr-docsroot}troubleshooting.adoc[Troubleshooting] | 68 | * xref:{devguide-docsroot}troubleshooting.html[Troubleshooting] |
73 | + | 69 | + |
74 | Get help on common problems. | 70 | Get help on common problems. |
75 | 71 | ||