Skip to content
Snippets Groups Projects
Commit 4e88cf56 authored by Martyn Welch's avatar Martyn Welch Committed by Emanuele Aina
Browse files

Remove redundant and completely outdated docs


We are rapidly removing the developer section, remove the index that is
broadly covered elsewhere. The FAQ is also either covered elsewhere or
completely out of date. The programming guides have been moved to the main
guide section and thus this is now pointless.

Signed-off-by: default avatarMartyn Welch <martyn.welch@collabora.com>
parent e6215382
No related branches found
No related tags found
1 merge request!103Organising the developer docs
......@@ -11,7 +11,12 @@ aliases = [
"/old-designs/latest",
"/old-designs/v2019",
"/old-designs/v2020",
"/old-designs/v2021dev3"
"/old-designs/v2021dev3",
"/old-developer/latest",
"/old-developer/v2019",
"/old-developer/v2020",
"/old-developer/v2021pre",
"/old-developer/v2022dev0",
]
+++
......@@ -76,4 +81,4 @@ Apertis provides a number of pre-built images for Intel (64-bit) and ARM (32-bit
* [Design documents]( {{< ref "designs" >}} )
* [Concept designs]( {{< ref "concepts" >}} )
* [Supported APIs]( {{< ref "apis.md" >}} )
* [Developer Guide]( {{< ref "developer/_index.md" >}} )
* [Developer Guide]( {{< ref "developer" >}} )
+++
license = "CC-BY-SAv4.0"
title = "Developer Guide"
weight = 100
aliases = [ "/old-developer/latest/index.html", "/old-developer/v2019/index.html", "/old-developer/v2020/index.html", "/old-developer/v2021pre/index.html", "/old-developer/v2022dev0/index.html",]
outputs = [ "html", "pdf-in",]
+++
The [FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) ([Free](http://en.wikipedia.org/wiki/Free_software) and [open source](http://en.wikipedia.org/wiki/Open-source_software)) GNU/Linux-based Apertis platform provides a set of APIs and services that allow you to create automotive information and entertainment apps. These APIs and services are made available in the Apertis SDK.
The SDK is a linux virtual machine running a standard desktop environment on
top of the Apertis distribution. It contains Apertis development libraries,
developer tools, documentation, debugging libraries and the Apertis simulator.
The SDK VM image can be run on Windows, Mac OS, or different Linux
distributions using the virtualization software
[VirtualBox]( {{< ref "virtualbox.md" >}} ).
### Next
* **Questions?** Read the [FAQ]( {{< ref "faq.md" >}} ).
* **Ready to start development?** [Install the SDK]( {{< ref "virtualbox.md" >}} ).
* **Want to create or update Apertis apps?** Find out [What's new in the latest version of Apertis]( {{< ref "#whats-new-in-this-version" >}} ) or use the [API quick links]( {{< ref "#apertis-api-quick-links" >}} ) below.
* **Ready to distribute your app?** Continue on to [Distribution]( {{< ref "canterbury-legacy-application-framework.md" >}} ).
## Support
If you encounter any problems using the SDK and need help, please send us an email at <sdk-support@apertis.org>.
+++
short-description = "Frequently Asked Questions"
license = "CC-BY-SAv4.0"
title = "FAQ"
weight = 100
aliases = [ "/old-developer/latest/faq.html", "/old-developer/v2019/faq.html", "/old-developer/v2020/faq.html", "/old-developer/v2021pre/faq.html", "/old-developer/v2022dev0/faq.html",]
outputs = [ "html", "pdf-in",]
date = "2016-11-30"
+++
#### Q: What is Apertis?
A: Apertis is a [FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) ([Free](http://en.wikipedia.org/wiki/Free_software) and [open source](http://en.wikipedia.org/wiki/Open-source_software)) GNU/Linux-based platform for infotainment in automotive vehicles. It is a distribution derived from Debian/Ubuntu and geared towards the creation of product-specific images for ARM and Intel x86 systems.
Apertis comes with a range of built-in features, which can be expanded upon with custom applications that are available through an App Store.
It is not intended to support mission-critical features in vehicles (such as steering, brakes, engine control, ''etc''.), rather provide the information (for example, web navigation, weather information, geolocation, contacts, ''etc''.) and entertainment (for example, radio, music, videos, ''etc''.) features, in an app-centric fashion. It is updated regularly to keep track of features and security fixes.
The [Apertis wiki](https://wiki.apertis.org/) is the primary source of information about Apertis.
#### Q: Where can I get help with developing applications for Apertis?
A: The App Developer Portal you are reading right now is the primary source of documentation for Apertis application development. You can also join the [mailing list for the Apertis project]( {{< ref "community.md" >}} ) and ask your question there. Your question may also have already been asked and/or answered in an [Apertis Phabricator](https://phabricator.apertis.org/search/query/advanced/) task.
#### Q: Will my application work on all Apertis devices?
A: Apertis is a building block for product specific images targeting different devices with very different features: Apertis provides standard interfaces to help application writers to target many vendors and devices with little effort.
#### Q: Can I write an Apertis application using Web technologies?
A: The Apertis Web runtime will be shipped as a technology preview in the upcoming Apertis 16.12 release.
#### Q: How do I file a bug?
A: Apertis bugs can be filed in the [Apertis Phabricator](https://phabricator.apertis.org/maniphest/task/edit/form/8/).
#### Q: How can I request to have a package added to Apertis?
A: Open a new task in the [Apertis Phabricator](https://phabricator.apertis.org/maniphest/task/edit/form/3/).
#### Q: How do I request an API enhancement?
A: Open a new task in the [Apertis Phabricator](https://phabricator.apertis.org/maniphest/task/edit/form/3/).
#### Q: How do I distribute my application for Apertis?
A: Distributing Apps for Apertis is covered in the [Distributing]( {{< ref "canterbury-legacy-application-framework.md" >}} ) section of this guide.
+++
license = "CC-BY-SAv4.0"
title = "Programming Guidelines"
weight = 100
aliases = [ "/old-developer/latest/programming-guide-index.html", "/old-developer/v2019/programming-guide-index.html", "/old-developer/v2020/programming-guide-index.html", "/old-developer/v2021pre/programming-guide-index.html", "/old-developer/v2022dev0/programming-guide-index.html",]
outputs = [ "html", "pdf-in",]
date = "2016-12-12"
+++
This guide contains several guidelines and suggestions for programmers developing applications for the Apertis platform. This is intended for programmers to know about the processes, conventions and philosophies behind Apertis and the stack of libraries supporting it. By knowing “the way things are done” in the Apertis ecosystem, it is hoped that programmers will find use of Apertis APIs and development of new applications easier and more natural, and will produce applications which will remain relevant and maintainable over a long period of time.
......@@ -5,6 +5,11 @@ weight = 100
title = "Guides"
aliases = [
"/old-developer/latest/programming-guide-index.html",
"/old-developer/v2019/programming-guide-index.html",
"/old-developer/v2020/programming-guide-index.html",
"/old-developer/v2021pre/programming-guide-index.html",
"/old-developer/v2022dev0/programming-guide-index.html",
"/old-wiki/Guidelines"
]
+++
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment