summaryrefslogtreecommitdiffstats
path: root/README.adoc
diff options
context:
space:
mode:
authorMerlin Carter <merlin.carter@here.com>2019-09-05 15:42:59 +0200
committerMerlin Carter <merlin.carter@here.com>2019-09-05 15:57:12 +0200
commitf2dcc347e576dc30ca1ac750a1c9d341a3d41dd5 (patch)
tree86fbd2516ca6da1753cb9f5909bb2647710e615a /README.adoc
parent948c3ea4e9a7e79d1de4a09e452fbdbbd5772073 (diff)
downloadmeta-updater-f2dcc347e576dc30ca1ac750a1c9d341a3d41dd5.tar.gz
OTA-3682: Remove the existing doc
Removing the existing meta-updater doc so it can be moved into the aktualizr repo. Also updated README to point to same files in aktualizr repo. Signed-off-by: Merlin Carter <merlin.carter@here.com>
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc24
1 files changed, 13 insertions, 11 deletions
diff --git a/README.adoc b/README.adoc
index 97b9987..af3d2ff 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,9 +1,7 @@
1= meta-updater 1= meta-updater
2:toc: macro 2:toc: macro
3:toc-title: 3:toc-title:
4:meta-updater-github-url: https://github.com/advancedtelematic/meta-updater/tree/master/ 4:aktualizr-docsroot: https://github.com/advancedtelematic/aktualizr/tree/master/docs/ota-client-guide/modules/ROOT/pages/
5
6ifndef::env-github[:meta-updater-github-url:]
7 5
8Meta-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]. 6Meta-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].
9 7
@@ -15,36 +13,40 @@ https://github.com/advancedtelematic/aktualizr[Aktualizr] (and https://github.co
15== Table of Contents 13== Table of Contents
16 14
17The 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]. 15The 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].
16[NOTE]
17====
18The following links point to files in the aktualizr repository where the source of the developer guide is stored.
19====
18 20
19* xref:{meta-updater-github-url}docs/modules/ROOT/pages/build.adoc[Build] 21* xref:{aktualizr-docsroot}meta-updater-build.adoc[Build]
20+ 22+
21Learn how to use this layer to build a basic disk image and add it to your own Yocto project. 23Learn how to use this layer to build a basic disk image and add it to your own Yocto project.
22+ 24+
23* xref:{meta-updater-github-url}docs/modules/ROOT/pages/supported-boards.adoc[Supported boards] 25* xref:{aktualizr-docsroot}supported-boards.adoc[Supported boards]
24+ 26+
25Find out if your board is supported and learn about the minimum hardware requirements. 27Find out if your board is supported and learn about the minimum hardware requirements.
26+ 28+
27* xref:{meta-updater-github-url}docs/modules/ROOT/pages/sota-variables.adoc[SOTA-related variables in local.conf] 29* xref:{aktualizr-docsroot}sota-variables.adoc[SOTA-related variables in local.conf]
28+ 30+
29Learn how to configure OTA-related functionality when building disk images. 31Learn how to configure OTA-related functionality when building disk images.
30+ 32+
31* xref:{meta-updater-github-url}docs/modules/ROOT/pages/meta-updater-usage.adoc[Usage] 33* xref:{aktualizr-docsroot}meta-updater-usage.adoc[Usage]
32+ 34+
33Learn about the `garage-push` and `garage-sign` utilities, aktualizr configuration and service resource control, and OSTree. 35Learn about the `garage-push` and `garage-sign` utilities, aktualizr configuration and service resource control, and OSTree.
34+ 36+
35* xref:{meta-updater-github-url}docs/modules/ROOT/pages/dev-config.adoc[Development configuration] 37* xref:{aktualizr-docsroot}meta-updater-dev-config.adoc[Development configuration]
36+ 38+
37Learn how to configure logging, install custom versions of aktualizr, and override the version indicator for sofware updates. 39Learn how to configure logging, install custom versions of aktualizr, and override the version indicator for sofware updates.
38+ 40+
39* xref:{meta-updater-github-url}docs/modules/ROOT/pages/meta-updater-testing.adoc#_qa_with_oe_selftest[QA with oe-selftest] 41* xref:{aktualizr-docsroot}meta-updater-testing.adoc#_qa_with_oe_selftest[QA with oe-selftest]
40+ 42+
41Learn how to use the `oe-selftest` framework for quality assurance. 43Learn how to use the `oe-selftest` framework for quality assurance.
42+ 44+
43* xref:{meta-updater-github-url}docs/modules/ROOT/pages/meta-updater-testing.adoc#_aktualizr_test_suite_with_ptest[Aktualizr test suite with ptest] 45* xref:{aktualizr-docsroot}meta-updater-testing.adoc#_aktualizr_test_suite_with_ptest[Aktualizr test suite with ptest]
44+ 46+
45Learn how to enable Yocto's package test functionality and run parts of the aktualizr test suite. 47Learn how to enable Yocto's package test functionality and run parts of the aktualizr test suite.
46+ 48+
47* xref:{meta-updater-github-url}docs/modules/ROOT/pages/provisioning-methods.adoc[Provisoning methods] 49* xref:{aktualizr-docsroot}meta-updater-provisioning-methods.adoc[Provisoning methods]
48+ 50+
49Learn how to enable different methods for provisioning devices. 51Learn how to enable different methods for provisioning devices.
50 52