summaryrefslogtreecommitdiffstats
path: root/docs/04_Developer_Guides
AgeCommit message (Collapse)AuthorFilesLines
2024-03-14Small corrections to avoid warningsMarius Vlad1-2/+2
- index.html is not needed - fixing relative links Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I1464ec731149ea8b914ef0ba9b3e7cc1a3ab399f Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29721 Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Reviewed-by: Lisandro Perez Meyer <lpmeyer@ics.com> Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> (cherry picked from commit 59752ca693a647f8aefead6cdb1d17a593cd1051) Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29736
2023-10-23Update application framework documentationScott Murray1-0/+144
Changes: - Moved "Creating a New Service" page back over to "Developer Guides" since it is not application framework specific. - Removed obsolete applaunchd D-Bus configuration documentation now that the functionality has been completely removed as of Pike. - Updated the application framework introduction discussion around protocols to document preference for gRPC over D-Bus for AGL projects. - Updated "Creating a New Application" documentation to document the requirements for having applications usable with applaunchd, as well as using the application templates, with BitBake recipe examples. - Added "Application Sandboxing" section that documents the existing example configurations and discusses other potential configuration options for systemd. Bug-AGL: SPEC-4928 Signed-off-by: Scott Murray <scott.murray@konsulko.com> Change-Id: I6e0c0afcf571d9214df5300d2082b15fa3bb2a27 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29284 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-10-23Move application framework sectionScott Murray9-973/+0
Move application framework section from "Developer Guides" to "Component Documentation" and fix all links. Bug-AGL: SPEC-4928 Signed-off-by: Scott Murray <scott.murray@konsulko.com> Change-Id: I6bb10908860860d6634b23f6a458959397a98e81 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29283 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-10-23Add documentation for AGL voice agentMalik Talha1-3/+3
This adds in-depth documentation of the voice agent service, flutter app, intent engines, and vosk kaldi. SPEC-4906 Signed-off-by: Malik Talha <talhamalik727x@gmail.com> Change-Id: I4ba8a76ff036100b2ec9ee72a224721e4cd919af Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29280 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-03-2701_Application_Framework: Add an extended version of app startupMarius Vlad5-2/+165
And activation, that describes in more detail how that is handled. Bug-AGL: SPEC-4700 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I5f9a2764d66947c06bf8dc346dfaef72d993733f Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28526 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-03-23Updating AGL Layer documentationVinod Ahuja4-216/+136
As per the guidance on Jira Ticket 3247 I have updated the AGL layer documentation. Bug-AGL: [SPEC-3247] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: Ibc97a5841b128da7dac7be314474dfb57ae7acd0 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28575 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-03-2201_Application_Framework: 02_Application_Startup_Dbus: Refer to D-Bus activationMarius Vlad2-3/+7
Creating a new application is as well quite specific to D-bus activation so use a dedicated page for it, and modify the links that point to it. Bug-AGL: SPEC-4700 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I3fd7174ac573e1670231570ff6422156b53e5a06 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28525 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-03-2201_Application_Framework: Moved D-bus actvation to its own pageMarius Vlad2-137/+287
The 02_Application_Startup pages actually contains quite a lot of D-Bus specific bits so move it to its own page, rather than adding items about the gRPC one. The gRPC part are inlined into the current page though. Bug-AGL: SPEC-4700 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I4808cc1773f071f2455e24b5417a8b30337cbb8a Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28524 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-03-2201_Application_Framework: Further clarify some bits about D-BusMarius Vlad1-13/+23
This clarifies some bits about D-Bus as being in deprecation phase and that gRPC should be used instead. Bug-AGL: SPEC-4700 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: Iec494e165db2b40586a285117dd9f8b0a38971b0 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28523 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-03-2201_Application_Framework: Migrate new service and new application creationMarius Vlad3-1/+1
This moves out 03_Creating_a_New_Service and 04_Creating_a_New_Application under Application Framework folder, as they don't really make sense being outside of it, when in fact they are referring quite a lot to the Application Framework, being dependent on the D-Bus IPC. Bug-AGL: SPEC-4700 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: I08819725efa89afe0b44ff7e3146906c43ff40d0 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28522 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-03-2201_Application_Framework: 01_Introduction.mdMarius Vlad1-71/+97
This formats the entire page to at most 80 characters wide pagraphs. Mentions that with 'needlefish' we started using gRPC and that we've started to deprecate D-Bus, including the fact that we no longer spawn directly applications, that we use system units for listing applications. Most the of page is kept intact with those minor changes being added. Bug-AGL: SPEC-4700 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Change-Id: Id19e6cea90fdbe9a6bd4eee851f83b9d0f800db5 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28521 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-01-29Fixing all the Yocto linksoctopus_14.94.0octopus/14.94.014.94.0Vinod Ahuja1-1/+1
Fixing all the broken Yocto links through out the documentation. Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: I1af1c7171cfb7d3f5f6233fd77ef0d1c0097d071 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28436 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2023-01-20Fixing broken linksoctopus_14.93.0octopus/14.93.014.93.0Vinod Ahuja4-8/+6
I have fixed all the broken links in the documentation except links for Yocto project and security section. Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: I1c05bf2c3a9365bba0b67077cf51b294352e7943 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28384 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2022-11-21Updating File name and links in the documentationoctopus_14.92.0octopus_14.91.0octopus/14.92.0octopus/14.91.014.92.014.91.0Vinod Ahuja12-0/+1284
Updating documentation: 1. Renamed all the files and folder following 01-99 index numbering 2. Matched title name and file name 3. Inserted title in the files where ever missing 4. Updated all the reference links in the documentation Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: Ib73e1f91107646e11b5b19ab6ead4080add506e4 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28170 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>