Skip to content

Commit

Permalink
OTA-3682: Remove the existing doc
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
Merlin Carter committed Sep 5, 2019
1 parent 948c3ea commit f2dcc34
Show file tree
Hide file tree
Showing 11 changed files with 17 additions and 388 deletions.
7 changes: 4 additions & 3 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
= Contributing
:aktualizr-docsroot: https://github.com/advancedtelematic/aktualizr/tree/master/docs/ota-client-guide/modules/ROOT/pages/

We welcome pull requests from anyone. The master branch is the primary branch for development, and if you wish to add new functionality, it probably belongs there. We attempt to maintain recent release branches and welcome bug fixes and backports for those. Please see the link:docs/modules/ROOT/pages/yocto-release-branches.adoc[release branches] documentation for the current list of support branches.
We welcome pull requests from anyone. The master branch is the primary branch for development, and if you wish to add new functionality, it probably belongs there. We attempt to maintain recent release branches and welcome bug fixes and backports for those. Please see the xref:{aktualizr-docsroot}yocto-release-branches.adoc[release branches] documentation for the current list of support branches.

If you are developing with meta-updater, it may be helpful to read the README and other documentation for link:README.adoc[this repo], https://github.com/advancedtelematic/aktualizr[aktualizr], and the https://github.com/advancedtelematic/updater-repo/[updater-repo], particularly the sections about development and debugging.
If you are developing with meta-updater, it may be helpful to read the README and other documentation for xref:README.adoc[this repo], https://github.com/advancedtelematic/aktualizr[aktualizr], and the link:https://github.com/advancedtelematic/updater-repo/[updater-repo], particularly the sections about development and debugging.

== Developer Certificate of Origin (DCO)

Expand All @@ -14,7 +15,7 @@ New pull requests will automatically be checked by the https://probot.github.io/

* OTA-enabled build succeeds for at least one platform, the resulting image boots, and an update can be installed. This check is absolutely necessary for every pull request unless it only touches documentation.
* If your change touches platform code (like `classes/sota_<platform>.bbclass`), please check building and updating on this particular platform.
* oe-selftest succeeds. To test meta-updater, run `oe-selftest -r updater` from a build directory with `MACHINE` set to `qemux86-64`. See the link:README.adoc#qa-with-oe-selftest[relevant section of the README] for more details.
* oe-selftest succeeds. To test meta-updater, run `oe-selftest -r updater` from a build directory with `MACHINE` set to `qemux86-64`. See the link:{aktualizr-docsroot}meta-updater-testing.adoc#qa-with-oe-selftest[relevant section of the README] for more details.
* Updates are forwards- and backwards-compatible. You should be able to update an OTA-enabled build before the change is applied to the version with change applied and vice versa. One should pay double attention to the compatibility when bootloader code is affected.
* The patch/branch should be based on the latest version of the target branch. This may mean that rebasing is necessary if other PRs are merged before yours is approved.

Expand Down
24 changes: 13 additions & 11 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
= meta-updater
:toc: macro
:toc-title:
:meta-updater-github-url: https://github.com/advancedtelematic/meta-updater/tree/master/

ifndef::env-github[:meta-updater-github-url:]
:aktualizr-docsroot: https://github.com/advancedtelematic/aktualizr/tree/master/docs/ota-client-guide/modules/ROOT/pages/

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].

Expand All @@ -15,36 +13,40 @@ https://github.com/advancedtelematic/aktualizr[Aktualizr] (and https://github.co
== Table of Contents

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].
[NOTE]
====
The following links point to files in the aktualizr repository where the source of the developer guide is stored.
====

* xref:{meta-updater-github-url}docs/modules/ROOT/pages/build.adoc[Build]
* xref:{aktualizr-docsroot}meta-updater-build.adoc[Build]
+
Learn how to use this layer to build a basic disk image and add it to your own Yocto project.
+
* xref:{meta-updater-github-url}docs/modules/ROOT/pages/supported-boards.adoc[Supported boards]
* xref:{aktualizr-docsroot}supported-boards.adoc[Supported boards]
+
Find out if your board is supported and learn about the minimum hardware requirements.
+
* xref:{meta-updater-github-url}docs/modules/ROOT/pages/sota-variables.adoc[SOTA-related variables in local.conf]
* xref:{aktualizr-docsroot}sota-variables.adoc[SOTA-related variables in local.conf]
+
Learn how to configure OTA-related functionality when building disk images.
+
* xref:{meta-updater-github-url}docs/modules/ROOT/pages/meta-updater-usage.adoc[Usage]
* xref:{aktualizr-docsroot}meta-updater-usage.adoc[Usage]
+
Learn about the `garage-push` and `garage-sign` utilities, aktualizr configuration and service resource control, and OSTree.
+
* xref:{meta-updater-github-url}docs/modules/ROOT/pages/dev-config.adoc[Development configuration]
* xref:{aktualizr-docsroot}meta-updater-dev-config.adoc[Development configuration]
+
Learn how to configure logging, install custom versions of aktualizr, and override the version indicator for sofware updates.
+
* xref:{meta-updater-github-url}docs/modules/ROOT/pages/meta-updater-testing.adoc#_qa_with_oe_selftest[QA with oe-selftest]
* xref:{aktualizr-docsroot}meta-updater-testing.adoc#_qa_with_oe_selftest[QA with oe-selftest]
+
Learn how to use the `oe-selftest` framework for quality assurance.
+
* xref:{meta-updater-github-url}docs/modules/ROOT/pages/meta-updater-testing.adoc#_aktualizr_test_suite_with_ptest[Aktualizr test suite with ptest]
* xref:{aktualizr-docsroot}meta-updater-testing.adoc#_aktualizr_test_suite_with_ptest[Aktualizr test suite with ptest]
+
Learn how to enable Yocto's package test functionality and run parts of the aktualizr test suite.
+
* xref:{meta-updater-github-url}docs/modules/ROOT/pages/provisioning-methods.adoc[Provisoning methods]
* xref:{aktualizr-docsroot}meta-updater-provisioning-methods.adoc[Provisoning methods]
+
Learn how to enable different methods for provisioning devices.

Expand Down
5 changes: 0 additions & 5 deletions docs/antora.yml

This file was deleted.

17 changes: 0 additions & 17 deletions docs/modules/ROOT/nav.adoc

This file was deleted.

62 changes: 0 additions & 62 deletions docs/modules/ROOT/pages/build.adoc

This file was deleted.

46 changes: 0 additions & 46 deletions docs/modules/ROOT/pages/dev-config.adoc

This file was deleted.

44 changes: 0 additions & 44 deletions docs/modules/ROOT/pages/meta-updater-testing.adoc

This file was deleted.

Loading

0 comments on commit f2dcc34

Please sign in to comment.