Merge pull request #1338 from advancedtelematic/docs/OTA-3746/add-git…

…hub-note OTA-3746: Adding github-only note
advancedtelematic · Sep 10, 2019 · b3f613a · b3f613a
2 parents a688e4a + f727f30
commit b3f613a
Show file tree

Hide file tree

Showing 78 changed files with 624 additions and 5 deletions.
diff --git a/docs/ota-client-guide/modules/ROOT/pages/account-setup.adoc b/docs/ota-client-guide/modules/ROOT/pages/account-setup.adoc
@@ -1,4 +1,12 @@
 = Set up multiple accounts
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 In OTA Connect, all devices and software belong to one *user* login. However, you don't want to mix up test software and production software by creating them all under the same user.
 

diff --git a/...lient-guide/modules/ROOT/pages/add-ota-functonality-existing-yocto-project.adoc b/...lient-guide/modules/ROOT/pages/add-ota-functonality-existing-yocto-project.adoc
@@ -1,4 +1,12 @@
 = Add OTA functionality to an existing Yocto project
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 :page-layout: page
 :page-categories: [quickstarts]
 :page-date: 2017-05-23 16:27:58

diff --git a/docs/ota-client-guide/modules/ROOT/pages/adoc-test.adoc b/docs/ota-client-guide/modules/ROOT/pages/adoc-test.adoc
@@ -1,4 +1,12 @@
 = Client provisioning methods
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 :page-layout: page
 :page-categories: [client-config]
 :page-date: 2018-07-05 13:31:58

diff --git a/docs/ota-client-guide/modules/ROOT/pages/aktualizr-config-options.adoc b/docs/ota-client-guide/modules/ROOT/pages/aktualizr-config-options.adoc
@@ -1,4 +1,12 @@
 = Client configuration options
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 :page-layout: page
 :page-categories: [client-config]
 :page-date: 2018-07-05 11:14:01

diff --git a/.../modules/ROOT/pages/aktualizr-runningmodes-finegrained-commandline-control.adoc b/.../modules/ROOT/pages/aktualizr-runningmodes-finegrained-commandline-control.adoc
@@ -1,4 +1,12 @@
 = Selectively trigger aktualizr
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 :page-layout: page
 :page-categories: [client-config]
 :page-date: 2018-08-22 11:01:14

diff --git a/docs/ota-client-guide/modules/ROOT/pages/build-agl.adoc b/docs/ota-client-guide/modules/ROOT/pages/build-agl.adoc
@@ -1,4 +1,12 @@
 = Build an Automotive Grade Linux image
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 :page-partial:
 :page-layout: page
 :page-categories: [quickstarts]

diff --git a/docs/ota-client-guide/modules/ROOT/pages/build-configuration.adoc b/docs/ota-client-guide/modules/ROOT/pages/build-configuration.adoc
@@ -1,4 +1,12 @@
 = Build Configuration Options
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 :page-partial:
 // MC: Included in aktualizr/docs/ota-client-guide/modules/ROOT/pages/build-configuration.adoc
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/build-images.adoc b/docs/ota-client-guide/modules/ROOT/pages/build-images.adoc
@@ -1,4 +1,12 @@
 = Build OTA-enabled Disk images
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 As described in the xref:workflow-overview.adoc[workflow overview], you use the Yocto tools to build a disk image that you can flash to your devices. This disk image includes the OTA Connect client, which communicates with the OTA Connect server. You can learn more about the Yocto tools, in the xref:yocto.adoc[Yocto section].
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/build-only-ostree.adoc b/docs/ota-client-guide/modules/ROOT/pages/build-only-ostree.adoc
@@ -1,4 +1,12 @@
 = I don't need to build the SD card images every time--how can I do a build that only does the OSTree part?
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 :page-layout: page
 :page-categories: [faq]
 :page-date: 2017-06-29 13:30:33

diff --git a/docs/ota-client-guide/modules/ROOT/pages/build-ota-enabled-images.adoc b/docs/ota-client-guide/modules/ROOT/pages/build-ota-enabled-images.adoc
@@ -1,3 +1,11 @@
 = Build OTA-enabled disk images
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 Aside from our demo recipes, you can also create your own Yocto project from scratch.
diff --git a/docs/ota-client-guide/modules/ROOT/pages/build-qemu.adoc b/docs/ota-client-guide/modules/ROOT/pages/build-qemu.adoc
@@ -1,4 +1,12 @@
 = Build a QEMU/VirtualBox 
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 :page-partial:
 :page-layout: page
 :page-categories: [quickstarts]

diff --git a/docs/ota-client-guide/modules/ROOT/pages/build-raspberry.adoc b/docs/ota-client-guide/modules/ROOT/pages/build-raspberry.adoc
@@ -1,4 +1,12 @@
 = Build a Raspberry Pi image
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 :page-partial:
 :page-layout: page
 :page-categories: [quickstarts]

diff --git a/docs/ota-client-guide/modules/ROOT/pages/client-provisioning-methods.adoc b/docs/ota-client-guide/modules/ROOT/pages/client-provisioning-methods.adoc
@@ -1,4 +1,12 @@
 = Device Provisioning Methods
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 :page-layout: page
 :page-categories: [client-config]
 :page-date: 2018-07-05 13:31:58

diff --git a/docs/ota-client-guide/modules/ROOT/pages/cross-deploy-images.adoc b/docs/ota-client-guide/modules/ROOT/pages/cross-deploy-images.adoc
@@ -1,4 +1,12 @@
 = Transfer disk images to a software repository in another account
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 :page-layout: page
 :page-categories: [prod]
 :page-date: 2018-03-15 13:52:05

diff --git a/docs/ota-client-guide/modules/ROOT/pages/deb-package-install.adoc b/docs/ota-client-guide/modules/ROOT/pages/deb-package-install.adoc
@@ -1,4 +1,12 @@
 == Installing aktualizr via debian package
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 Aktualizr makes .deb packages available via the https://github.com/advancedtelematic/aktualizr/releases[GitHub releases page]. Download and install the .deb package, for example:
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/debugging-tips.adoc b/docs/ota-client-guide/modules/ROOT/pages/debugging-tips.adoc
@@ -1,4 +1,12 @@
 = Aktualizr Debugging Tips
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 :aktualizr-github-url: https://github.com/advancedtelematic/aktualizr/tree/master
 
 == Running Aktualizr in development

diff --git a/docs/ota-client-guide/modules/ROOT/pages/deploy-checklist.adoc b/docs/ota-client-guide/modules/ROOT/pages/deploy-checklist.adoc
@@ -1,4 +1,12 @@
 = Deployment Checklist
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 OTA Connect is designed to integrate easily into development workflows: you build your image, push it, set auto-updates for some of your test-bench devices, and so on. But once you're ready to move from testing into production, you will likely want to do a few things differently. 
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/developer-tools.adoc b/docs/ota-client-guide/modules/ROOT/pages/developer-tools.adoc
@@ -1,4 +1,12 @@
 = Developer Tools
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 Before we walk you through the basic workflow of an OTA update, it would be helpful to understand the tools that are involved at each stage.
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/device-cred-prov-steps.adoc b/docs/ota-client-guide/modules/ROOT/pages/device-cred-prov-steps.adoc
@@ -1,4 +1,12 @@
 = Set Up Device Provisioning
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 In this section, you'll learn how provisioning in production is different from the provisioning method that you used to get started. You'll also understand the major steps involved in provisioning devices for production.
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/device-cred-prov-teststeps.adoc b/docs/ota-client-guide/modules/ROOT/pages/device-cred-prov-teststeps.adoc
@@ -1,4 +1,12 @@
 = Text Device-credential Provisioning
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 Although shared-credential provisioning is useful for evaluating OTA Connect, we don't recommend that you use it in production.
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/ecu_events.adoc b/docs/ota-client-guide/modules/ROOT/pages/ecu_events.adoc
@@ -1,4 +1,12 @@
 = Client events reporting
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 :aktualizr-github-url: https://github.com/advancedtelematic/aktualizr/tree/master
 
 This is a technical document describing the format of the events reported to the back-end by aktualizr during an ongoing update installation.

diff --git a/docs/ota-client-guide/modules/ROOT/pages/enable-device-cred-provisioning.adoc b/docs/ota-client-guide/modules/ROOT/pages/enable-device-cred-provisioning.adoc
@@ -1,4 +1,12 @@
 = Enable device-credential provisioning and install device certificates 
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 //MC: This is a copy of the topic "enable-device-cred-provtest.adoc" but intended for the "deploy/production" use case. Need to use more includes to reduce redundancy.
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/enable-device-cred-provtest.adoc b/docs/ota-client-guide/modules/ROOT/pages/enable-device-cred-provtest.adoc
@@ -1,4 +1,12 @@
 = Enable device-credential provisioning and install device certificates 
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 //MC: This is a copy of the topic "enable-device-cred-provisioning.adoc" but intended for the "test" use case. Need to use more includes to reduce redundancy.
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/enable-shared-cred-provisioning.adoc b/docs/ota-client-guide/modules/ROOT/pages/enable-shared-cred-provisioning.adoc
@@ -1,4 +1,12 @@
 = Enable shared-credential provisioning
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 If you build a disk image with the default configuration, shared-credential provisioning is enabled by default. You can also enable it explicitly in your build configuration.
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/evaluation-to-prod.adoc b/docs/ota-client-guide/modules/ROOT/pages/evaluation-to-prod.adoc
@@ -1,4 +1,12 @@
 = Moving from evaluation to production
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 The procedures to deploy OTA Connect in production are a little more complex than the basic xref:dev@getstarted::index.adoc[Get Started]  procedures.
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/fault-injection.adoc b/docs/ota-client-guide/modules/ROOT/pages/fault-injection.adoc
@@ -1,4 +1,12 @@
 = Running aktualizr with fault injection
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 ifdef::env-github[:simulatelink: link:https://docs.ota.here.com/ota-client/dev/simulate-device-basic.html[Simulate a device without building a disk image]]
 ifndef::env-github[:simulatelink: xref:dev@getstarted::simulate-device-basic.adoc[Simulate a device without building a disk image]]
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/generate-devicecert.adoc b/docs/ota-client-guide/modules/ROOT/pages/generate-devicecert.adoc
@@ -1,6 +1,12 @@
 = Device Certificate Generation
 
-// MC: This is a slightly altered copy of "generatetest-devicecert.adoc" with wording that explains you should only use the examples as a reference, since we can't know the customers "real" certificate generation process.
+ifdef::env-github[]
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 Once you have your final fleet root certificate, you can use it to generate and sign device certificates. You can then automate the process of installing device certificates on your devices. 
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/generate-selfsigned-root.adoc b/docs/ota-client-guide/modules/ROOT/pages/generate-selfsigned-root.adoc
@@ -1,4 +1,12 @@
 = Generate a self-signed root certificate
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 When you move to production, you'll need to register your fleet root certificate with OTA Connect server. This certificate needs to be signed by a trusted Certificate Authority (CA).
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/generatetest-devicecert.adoc b/docs/ota-client-guide/modules/ROOT/pages/generatetest-devicecert.adoc
@@ -1,4 +1,12 @@
 = Generate a test device certificate
+ifdef::env-github[]
+
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 
 // MC: This is a slightly altered copy of "generate-devicecert.doc" with wording that explains the process from the perspective of testing with a self-signed root cert.
 

diff --git a/docs/ota-client-guide/modules/ROOT/pages/generating-provisioning-credentials.adoc b/docs/ota-client-guide/modules/ROOT/pages/generating-provisioning-credentials.adoc
@@ -1,3 +1,10 @@
+ifndef::env-github[]
+[NOTE]
+====
+We recommend that you link:https://docs.ota.here.com/ota-client/latest/{docname}.html[view this article in our documentation portal]. Not all of our articles render correctly in GitHub.
+====
+endif::[]
+
 include::dev@ota-web:ROOT:page$create-provisioning-key.adoc[]
 
 // MC: Images don't render from included files, added local copies of 's1-prov.png' and 'screenshot_provisioning_key_2.png' (from "ota-web") until I can find a better solution.