AGL/documentation.git
7 months ago02_agl_compositor.md: How to change default ref UI 32/29732/2 pike 16.0.5 pike/16.0.5 pike_16.0.5
Marius Vlad [Tue, 27 Feb 2024 08:59:51 +0000 (10:59 +0200)]
02_agl_compositor.md: How to change default ref UI

02_agl_compositor.md: Add simple client examples + how to
incorporate/integrate a different UI.

Bug-AGL: SPEC-4832
Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: I5750c309dc36f5a87bbeab492efa730e7e0c708a
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29724
Reviewed-by: Lisandro Perez Meyer <lpmeyer@ics.com>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29732

7 months ago02_agl_compositor.md: Update agl-shell versions 31/29731/2
Marius Vlad [Mon, 26 Feb 2024 18:23:55 +0000 (20:23 +0200)]
02_agl_compositor.md: Update agl-shell versions

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: I8d27816611990ee736deaaf33aa4ddab31f51f85
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29723
Reviewed-by: Lisandro Perez Meyer <lpmeyer@ics.com>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29731

7 months ago02_agl_compositor: Added gRPC proxy docs 30/29730/2
Marius Vlad [Mon, 26 Feb 2024 17:30:42 +0000 (19:30 +0200)]
02_agl_compositor: Added gRPC proxy docs

Adds the proto buf protocol as well as pointing out to
agl-shell-activator or window-management-clieng-grpc.

Bug-AGL: SPEC-4833
Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: Ib683c09e81cfbb03c9fdbc290e475c6563de9025
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29722
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Reviewed-by: Lisandro Perez Meyer <lpmeyer@ics.com>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29730

7 months agoSmall corrections to avoid warnings 29/29729/2
Marius Vlad [Mon, 26 Feb 2024 14:38:02 +0000 (16:38 +0200)]
Small corrections to avoid warnings

- 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>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29729

7 months ago01_AGL_components, 02_agl_compositor: Remove Waltham mentions 28/29728/2
Marius Vlad [Mon, 26 Feb 2024 13:49:47 +0000 (15:49 +0200)]
01_AGL_components, 02_agl_compositor: Remove Waltham mentions

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: Iec9e1b1c75c134a297dab3f8fa5a4fe38ea863db
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29720
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Reviewed-by: Lisandro Perez Meyer <lpmeyer@ics.com>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29728

11 months agoUpdate application framework documentation 62/29362/2 16.0.3 16.0.4 pike/16.0.3 pike/16.0.4 pike_16.0.3 pike_16.0.4
Scott Murray [Tue, 17 Oct 2023 20:48:46 +0000 (16:48 -0400)]
Update application framework documentation

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>
(cherry picked from commit 04ae05c69a1ee2934b139b179d15ba112ff18ab6)
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29362

12 months agoMove application framework section 57/29357/2
Scott Murray [Tue, 10 Oct 2023 22:03:44 +0000 (18:03 -0400)]
Move application framework section

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>
(cherry picked from commit ecccce4b62c048272dd48378cc05d7165746b83e)
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29357

12 months agoEnable header permalinks 58/29358/2
Scott Murray [Tue, 17 Oct 2023 20:54:42 +0000 (16:54 -0400)]
Enable header permalinks

Use the toc extension "permalinks" option to enable header permalinks.

Bug-AGL: SPEC-4927

Signed-off-by: Scott Murray <scott.murray@konsulko.com>
Change-Id: If06b1172d1dd295cc22e60bdf89f301b0c880ae6
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29285
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
(cherry picked from commit ae87e29eeaeadd67a449f8827aa8d4adbe2076b5)
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29358

14 months agoUpdate build producer document for AGL IC container integration 77/29077/4 16.0.1 16.0.2 pike/16.0.1 pike/16.0.2 pike_16.0.1 pike_16.0.2
Vinod Ahuja [Wed, 7 Jun 2023 19:51:14 +0000 (14:51 -0500)]
Update build producer document for AGL IC container integration

Updating AGL IC container integration documentation based on revised
documentation available on confluence
https://confluence.automotivelinux.org/display/IC/Build+Procedure+for+AGL+IC+with+Container+Integration

Bug-AGL: [SPEC-4805]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: I6f49d3ee846bfee371662d0ac1b98dbd3fd76bbb
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29000
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
(cherry picked from commit c71f2899ee9c53f69d64ff44aeebf5f36eb0ac0b)
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29077

14 months agoDocs: Updates prior to Prickly Pike release 12/29112/2
Jan-Simon Möller [Wed, 9 Aug 2023 12:54:29 +0000 (14:54 +0200)]
Docs: Updates prior to Prickly Pike release

Update the documentation with 'pike' specific instructions
and links.

Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
Change-Id: If8396da3000d1aad91d9e31ab4ac1110ca649f92
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/29112

15 months agoAdd gitreview file for Prickly Pike branch 15.93.0 16.0.0 pike/15.93.0 pike/16.0.0 pike_15.93.0 pike_16.0.0
Jan-Simon Moeller [Mon, 31 Jul 2023 15:27:02 +0000 (17:27 +0200)]
Add gitreview file for Prickly Pike branch

Update the .gitreview file.

Bug-AGL: SPEC-4867
Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Change-Id: I6ad0b8d430b328268c398ccbba271c0ccaf904bc

17 months agoRemoving Waltham page 72/28872/3 15.91.0 15.91.1 15.92.0 pike/15.91.0 pike/15.91.1 pike/15.92.0 pike_15.91.0 pike_15.91.1 pike_15.92.0
Vinod Ahuja [Wed, 10 May 2023 19:52:27 +0000 (14:52 -0500)]
Removing Waltham page

Removing Waltham page as dicussed in community meeting.

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: Ibc28380500ba7454ac695894fd9a5f084f04f359
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28872
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
18 months agoUpdating AGL LAVA Lab setup page 83/28783/3
Vinod Ahuja [Wed, 3 May 2023 20:59:46 +0000 (15:59 -0500)]
Updating AGL LAVA Lab setup page

1. Fixing Title formatting.
2. Providing a brief overview about what LAVA Lab.

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: Icebc5796c4396e9bd73ab0cf033ad345e204398c
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28783
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
18 months agoUpdating information for building AGL cluster images 37/28637/2
Vinod Ahuja [Wed, 12 Apr 2023 21:37:47 +0000 (16:37 -0500)]
Updating information for building AGL cluster images

Updating Run aglsetup.sh scripts
Updating Using BitBake image information

Bug-AGL: [SPEC-4604]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: If6489d14c0e479b6fa10ee4c97863aae4829abe2
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28637
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
18 months agodocumentation: fix typo 30/28630/3
anujsolanki62 [Mon, 10 Apr 2023 06:10:34 +0000 (11:40 +0530)]
documentation: fix typo

Correct typo in git config command

Bug-AGL: SPEC-4752
Signed-off-by: Anuj Solanki <anuj603362@gmail.com>
Change-Id: Ibaa9a524ffb2a75fec6a43ced819611914d6fb45
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28630
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
18 months agoIVI Flutter apps: correct build directory path 29/28629/3
Anuj-S62 [Mon, 10 Apr 2023 04:55:11 +0000 (10:25 +0530)]
IVI Flutter apps: correct build directory path

Changed build-flutter-dashboard directory path

Bug-AGL: SPEC-4752
Signed-off-by: Anuj Solanki <anuj603362@gmail.com>
Change-Id: Ie9325b325378b5cec3527fab179e536012008a69
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28629
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
18 months agodocumentation: fix typo 28/28628/2
Yan [Fri, 7 Apr 2023 06:30:18 +0000 (14:30 +0800)]
documentation: fix typo

typo on 'frameword', now is fixed.

Bug-AGL: SPEC-1902
Signed-off-by: Yan <yanxk.fnst@fujitsu.com>
Change-Id: I57c58bbb2300cab496958e8d3ff297723d8c942d
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28628
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
19 months agoUpdating AGL feature 24/28624/3
Vinod Ahuja [Tue, 4 Apr 2023 22:58:49 +0000 (17:58 -0500)]
Updating AGL feature

Updating AGL feature list to match with git listed features and adding
link to the git feature repository. Not adding the descriptions for some
of some features as readme files of those feature are not updated.

Bug-AGL: [SPEC-1902]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: Ib2f74868b417b49d09193341a1ab1e44e412c375
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28624
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
19 months ago01_Application_Framework: Add an extended version of app startup 26/28526/4
Marius Vlad [Wed, 22 Feb 2023 16:29:42 +0000 (18:29 +0200)]
01_Application_Framework: Add an extended version of app startup

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>
19 months agoUpdating AGL Layer documentation 75/28575/4
Vinod Ahuja [Thu, 16 Mar 2023 23:18:55 +0000 (18:18 -0500)]
Updating AGL Layer documentation

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>
19 months ago01_Application_Framework: 02_Application_Startup_Dbus: Refer to D-Bus activation 25/28525/2
Marius Vlad [Wed, 22 Feb 2023 13:30:09 +0000 (15:30 +0200)]
01_Application_Framework: 02_Application_Startup_Dbus: Refer to D-Bus activation

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>
19 months ago01_Application_Framework: Moved D-bus actvation to its own page 24/28524/2
Marius Vlad [Wed, 22 Feb 2023 10:53:46 +0000 (12:53 +0200)]
01_Application_Framework: Moved D-bus actvation to its own page

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>
19 months ago01_Application_Framework: Further clarify some bits about D-Bus 23/28523/2
Marius Vlad [Wed, 22 Feb 2023 09:58:12 +0000 (11:58 +0200)]
01_Application_Framework: Further clarify some bits about D-Bus

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>
19 months ago01_Application_Framework: Migrate new service and new application creation 22/28522/2
Marius Vlad [Wed, 22 Feb 2023 09:56:16 +0000 (11:56 +0200)]
01_Application_Framework: Migrate new service and new application creation

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>
19 months ago01_Application_Framework: 01_Introduction.md 21/28521/2
Marius Vlad [Wed, 22 Feb 2023 08:04:37 +0000 (10:04 +0200)]
01_Application_Framework: 01_Introduction.md

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>
21 months agoFixing all the Yocto links 36/28436/2 14.94.0 octopus/14.94.0 octopus_14.94.0
Vinod Ahuja [Thu, 26 Jan 2023 22:59:52 +0000 (16:59 -0600)]
Fixing all the Yocto links

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>
21 months agoFixing broken links 84/28384/3 14.93.0 octopus/14.93.0 octopus_14.93.0
Vinod Ahuja [Mon, 16 Jan 2023 23:22:18 +0000 (17:22 -0600)]
Fixing broken links

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>
22 months agoUpdating test hyperlink option 01/28301/2
Vinod Ahuja [Mon, 19 Dec 2022 20:13:11 +0000 (14:13 -0600)]
Updating test hyperlink option

Suggested Linkchecker software is no longer maintained further it
requires python 2 rather python 3. Further after testing Linkchecker I
found that it missed many links.

I have tried broken-link-checker npm package which detects many of the
links not detected by Linkchecker. Therefore proposing using this new
software for checking website links.

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: If1913104225f4b97c4b1265bdeace4b214128d6c
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28301
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
23 months agoUpdating File name and links in the documentation 70/28170/2 14.91.0 14.92.0 octopus/14.91.0 octopus/14.92.0 octopus_14.91.0 octopus_14.92.0
Vinod Ahuja [Sat, 19 Nov 2022 19:59:20 +0000 (13:59 -0600)]
Updating File name and links in the documentation

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>
23 months agoAdding file naming and indexing 30/28130/2
Vinod Ahuja [Wed, 9 Nov 2022 19:02:42 +0000 (13:02 -0600)]
Adding file naming and indexing

Adding details of file naming convention and indexing the files.

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: I189d725d2a4793f687826ffb4ecfca8c71b0f44a
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28130
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
23 months agoFixing the index numbering 18/28118/3
Vinod Ahuja [Mon, 7 Nov 2022 22:18:44 +0000 (16:18 -0600)]
Fixing the index numbering

Fixing the index numbering for all documentation

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: I96b482a3ab598f0739c692e301de66c0553ba0e4
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28118
Reviewed-by: Walt Miner <wminer@linuxfoundation.org>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoFixing broken links and formatting in App Framework page 98/28098/2
Vinod Ahuja [Mon, 31 Oct 2022 21:42:08 +0000 (16:42 -0500)]
Fixing broken links and formatting in App Framework page

Fixing formatting and reference broken links in application framework page.

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: Id155ff687a370890318817633ce1831bc5ce6389
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28098
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoAdding various platforms used by agl 64/28064/3
Vinod Ahuja [Mon, 24 Oct 2022 21:28:03 +0000 (16:28 -0500)]
Adding various platforms used by agl

Adding the list of platforms AGL uses for different purposes.

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: I064d8219e13595cf6a28e8e053f835a2e98f0b2e
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28064
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoFixing the branch name in latest stable release 63/28063/2
Vinod Ahuja [Mon, 24 Oct 2022 20:41:28 +0000 (15:41 -0500)]
Fixing the branch name in latest stable release

Fixing the branch name for the latest stable release branch.

Bug-AGL: [SPEC-4590]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: If63436f9d237aa37035a1fc72d7816bb9667120c
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28063
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoFixing SSH key generation problem 37/28037/2
Vinod Ahuja [Thu, 29 Sep 2022 21:42:41 +0000 (16:42 -0500)]
Fixing SSH key generation problem

I installed Ubuntu 22.04 and RSA protocol for ssh key pair was not working and was constantly getting permission denined key pair mismatch issues.
After following openstac documentation (https://docs.openstack.org/contributors/common/setup-gerrit.html) I was quickly able to fix SSH key setup issue.
Open Stack recommended to use ed25519 keys protocol as it works well in all operating system.
Following that recommendation and personally experience issues with RSA key generation I have updated the documentation to ed25519.

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: I6209337e0056821ec9a0f28ea9aabb9d0933c53e
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28037
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoAdd documentation for Flutter IVI dashboard applications 29/28029/3
hritikchouhan [Sat, 24 Sep 2022 09:54:23 +0000 (02:54 -0700)]
Add documentation for Flutter IVI dashboard applications

This will add documentation to build and boot the
agl-ivi-demo-platform-flutter homescreen using QEMU.

Change-Id: Ieee92c3cdb0c7598f5df64ebe9d4c705c46e7e20
Signed-off-by: hritikchouhan <hritikc3961@gmail.com>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28029
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoImproving Developer 3_Developer_Guides 93/27993/5
Vinod Ahuja [Mon, 12 Sep 2022 22:22:20 +0000 (17:22 -0500)]
Improving Developer 3_Developer_Guides

Worked on creating new services and applications.
1. Removed Fixme file
2. Formatted some text and numbering
3. Fixed some broken links.

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: If3f9a171faff8466bd6d141f9537cd98468fadbb
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27993
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoagl-compositor.md: Add some notes about v2 and v3 protocol update 99/27999/2
Marius Vlad [Fri, 16 Sep 2022 11:34:50 +0000 (14:34 +0300)]
agl-compositor.md: Add some notes about v2 and v3 protocol update

This includes some notes which might be useful for people to reason
about why these updates are happening.

Bug-AGL: SPEC-4528
Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: I526af1b1b12f9bfbeae106d6ec4a436de172d318
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27999
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoAdd steps to enable navigation 00/28000/2
aakash-s45 [Fri, 16 Sep 2022 13:09:39 +0000 (18:39 +0530)]
Add steps to enable navigation

To enable navigation, OPENROUTE_API_KEY variable need to be
set in local.conf

Bug-AGL: SPEC-4543

Change-Id: I4acab227e2bbb58b25891dced4eab4fcc3be66f1
Signed-off-by: aakash-s45 <tech2aks@gmail.com>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28000
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoAdd documentation for Flutter Instrument Cluster 69/27969/4
aakash-s45 [Sat, 3 Sep 2022 08:32:12 +0000 (14:02 +0530)]
Add documentation for Flutter Instrument Cluster

This will add documentation to build and boot the
agl-cluster-demo-platform-flutter demo image using
QEMU

Bug-AGL: SPEC-4543

Change-Id: I659f2d953afa76bc6fe51731258f7b3b5f747431
Signed-off-by: Aakash Solanki <tech2aks@gmail.com>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27969
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoFixing broken links 72/27972/3
Vinod Ahuja [Mon, 5 Sep 2022 20:55:39 +0000 (15:55 -0500)]
Fixing broken links

Fixing sevral broken links pointing to yacto project documentation.

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: Ice74da910a6ec7d216b55bf209eed3cc65ae2c53
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27972
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoFixing Several broken links referring to Yacto 71/27971/4
Vinod Ahuja [Mon, 5 Sep 2022 20:30:11 +0000 (15:30 -0500)]
Fixing Several broken links referring to Yacto

Fixing several broken links referring to Yacto Project

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: I42a3ed35dde10e01338e5fdc0fc6ffdb33e80cab
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27971
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoFixing broken links in Developer Guides 57/27957/5
Vinod Ahuja [Mon, 29 Aug 2022 21:15:57 +0000 (16:15 -0500)]
Fixing broken links in Developer Guides

1. Fixing broken links in Developer guides -> setting up AGL SDK in step 1
2. Renaming files in command line code based on the file downloaded in step 1
3. Putting notes for changing the .sh file in different commands

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: I011b958ebab8319ae5f3b519875abb389615b33c
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27957
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
ci-image-boot-test: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoUpdating Hardware Support Page 41/27941/5
Vinod Ahuja [Mon, 22 Aug 2022 20:55:00 +0000 (15:55 -0500)]
Updating Hardware Support Page

1. Fixing some typos
2. Adding latest snapshot
3. Adding source to tar and binary
4. Separating pages for supported hardware and software

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: I00b80b0d6e8c37f853687860fc5d08d25490df0d
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27941
Reviewed-by: Scott Murray <scott.murray@konsulko.com>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
ci-image-boot-test: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoAdding description of supported boards 55/27855/2
Vinod Ahuja [Mon, 1 Aug 2022 20:09:33 +0000 (15:09 -0500)]
Adding description of supported boards

Adding description of supported boards and link to thier quick starting

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: I39d492ebde39300136b503f87aaec7bc08632e51
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27855
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoAdding participate section and other minor edits 93/27793/4
Vinod Ahuja [Mon, 25 Jul 2022 19:00:11 +0000 (14:00 -0500)]
Adding participate section and other minor edits

1. Removing some of the repetitive bullet points from the main page.
2. Adding detail participate section to the main page
3. Fixing some formatting.
4. Removing references to the wiki page for AGL distrou and google calendar

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: I82d581ca05d6e0ee824465631c4e404caf2e4f86
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27793
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoFirst round of updates to Hardware Support page 95/27795/2 13.92.0 13.93.0 needlefish/13.92.0 needlefish/13.93.0 needlefish_13.92.0 needlefish_13.93.0
Jan-Simon Moeller [Tue, 26 Jul 2022 13:36:18 +0000 (15:36 +0200)]
First round of updates to Hardware Support page

Update the supported boards for the master branch.

Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Change-Id: If3564e29519e9d45a2bca6d4e464ee16207b133e
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27795

2 years agoAdding submitting change guideline 63/27763/3
Vinod Ahuja [Tue, 12 Jul 2022 20:10:01 +0000 (15:10 -0500)]
Adding submitting change guideline

Adding note for committer to follow submitting change guideline.

Bug-AGL: SPEC-4470
Change-Id: I40f26d9ab6e4d574e39ec677caa856a38ca94888
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27763
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoReducing Image size as discussed in SAT meeting 49/27749/2
Vinod Ahuja [Fri, 8 Jul 2022 18:48:56 +0000 (13:48 -0500)]
Reducing Image size as discussed in SAT meeting

Change-Id: I686ad428a9b6e3552fcdfd7a2048aa236c6a17b6
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27749
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoDocument building isolation container images 67/27667/7 13.91.0 needlefish/13.91.0 needlefish_13.91.0
Mohamed Amir [Thu, 16 Jun 2022 13:09:24 +0000 (22:09 +0900)]
Document building isolation container images

This commit adds a new instruction document for the
Instrument Cluster target.
To reduce the main build section, we split the profile
description and build page.

Then, add a new section as follow:

|-- 0_Getting_Started
|   |-- 1_Quickstart
|   |-- 2_Building_AGL_Image
|   `-- 3_Build_and_Boot_guide_Profile
|       `-- 1_Instrument_Cluster_(IC-IVI_with_Container_isolation).md

Bug-AGL: SPEC-4190

Signed-off-by: Mohamed Amir <mohamed@hhq.suzuki.co.jp>
Signed-off-by: Harunobu Kurokawa <harunobu.kurokawa.dn@renesas.com>
Change-Id: Ib031f8656da5ae77454a662f765ed5f7159b8e1e
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27667
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Reviewed-by: Naoto YAMAGUCHI <naoto.yamaguchi@aisin.co.jp>
2 years ago1_agl-compositor.md: Document how to start client shell 67/27567/2
Marius Vlad [Fri, 27 May 2022 12:02:48 +0000 (15:02 +0300)]
1_agl-compositor.md: Document how to start client shell

While that's not the way we do it AGL, let us document how to start
a client shell from the compositor.

Bug-AGL: SPEC-4400
Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: I2661686aa6d437cc789569aad8259f6aa9a45989
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27567
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years ago1_agl-compositor.md: We're no longer using SMACK 66/27566/2
Marius Vlad [Fri, 27 May 2022 11:57:34 +0000 (14:57 +0300)]
1_agl-compositor.md: We're no longer using SMACK

Removes any mention of SMACK and use a more generic term. Also,
s/AFM/AppFW/

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: I18dd7dd4f76fb4cba9cd5be55510f08ec3c36b8e
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27566
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years ago5_Component_Documentation: Fix Application Framework links 65/27565/2
Marius Vlad [Fri, 27 May 2022 11:32:41 +0000 (14:32 +0300)]
5_Component_Documentation: Fix Application Framework links

Use relative links to link correctly to AppFW.

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: Iefefc031d77b54a09f2cdfcead5e1dd13e3b7170
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27565
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoFixed quote errors in echo expressions 75/27575/2
amanarora9848 [Tue, 31 May 2022 17:42:54 +0000 (23:12 +0530)]
Fixed quote errors in echo expressions

Enclosed the echo expressions in double quotes (which previously had single quotes) for the following pages to prevent build errors:
1. Customizing Your Build
2. Building the AGL Image
  a. Building for x86 (Emulation and Hardware)
  b. Building for Raspberry Pi 4
  c. Building for Supported Renesas Boards

Signed-off-by: amanarora9848 <aman.arora9848@gmail.com>
Change-Id: I18543d001e5da6fbdcf11d72236122c7e6ffdac1
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27575
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoFixed internal link error 20/27520/2
amanarora9848 [Mon, 23 May 2022 18:24:49 +0000 (23:54 +0530)]
Fixed internal link error

Fixed the internal hyperlink for 'Pipewire & Wireplumber' page present on the 'Components under development' within AGL page.

Signed-off-by: amanarora9848 <aman.arora9848@gmail.com>
Change-Id: Icf36a96c4a55638956185890ce8f6418d95a59d5
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27520
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoFixed indentation error for a sub-bullet point 70/27370/2
amanarora9848 [Sat, 9 Apr 2022 11:51:23 +0000 (17:21 +0530)]
Fixed indentation error for a sub-bullet point

Formatted the point 3 in the document "Preparing Your Build Host"

Signed-off-by: amanarora9848 <aman.arora9848@gmail.com>
Change-Id: Id42e143305189121129f8ac940c5bf86a6d80ebf
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27370
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoRCAR: Update BSP version in documentation 31/27231/2 12.93.0 marlin/12.93.0 marlin_12.93.0
Frederic Marec [Tue, 1 Mar 2022 09:19:33 +0000 (10:19 +0100)]
RCAR: Update BSP version in documentation

Following SPEC-4234

Bug-AGL: SPEC-4273

Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
Change-Id: Ie15b7f056f2268c79f7c27742c26e708ab78d48e
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27231
Reviewed-by: Harunobu Kurokawa <harunobu.kurokawa.dn@renesas.com>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years ago3_Developer_Guides: add new app framework documentation 66/27166/4
Arnaud Ferraris [Fri, 11 Feb 2022 20:06:46 +0000 (21:06 +0100)]
3_Developer_Guides: add new app framework documentation

Starting with `marlin`, the old AppFW has been phased out and replaced
by a new implementation, relying mainly on standard technologies and
software. This commit documents the current state of the new Application
Framework so developers can create compliant applications.

Bug-AGL: SPEC-4236
Signed-off-by: Arnaud Ferraris <arnaud.ferraris@collabora.com>
Change-Id: I4cf52799426efbc2401b8785aaa57cc925a4968f
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27166
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years ago3_Developer_Guides/5_General_setup: Simple docs for video camera streaming 34/27134/2
Marius Vlad [Thu, 3 Feb 2022 22:06:30 +0000 (00:06 +0200)]
3_Developer_Guides/5_General_setup: Simple docs for video camera streaming

This mostly targets rpi4 as a camera and display are rather easy to get
by, but also vivid testing module which can also be used from h3ulcb.

Bug-AGL: SPEC-4170

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: Id76c2a2bf5c1156de70c906c0534c36b36af30c4
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27134
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years ago0_AGL_components.md: Clear up missing files 33/27133/2
Marius Vlad [Thu, 3 Feb 2022 14:32:46 +0000 (16:32 +0200)]
0_AGL_components.md: Clear up missing files

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: I08e32b560fcd292f923a54c676e2c22937dd4e9d
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27133
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoUpdate to documentation before Marlin 97/27097/3 12.92.0 marlin/12.92.0 marlin_12.92.0
Jan-Simon Möller [Wed, 26 Jan 2022 11:25:31 +0000 (12:25 +0100)]
Update to documentation before Marlin

This is mostly a cleanup before the Magic Marlin Release.
We do have the Application Framework chapter rewrite pending.

Bug-AGL: SPEC-4236
Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
Change-Id: I7e1f39667b4db417497b1d0c84065c173fa18439
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27097

2 years agoFix a spell miss of document. 51/27051/2 12.91.0 marlin/12.91.0 marlin_12.91.0
Qiu Tingting [Tue, 21 Dec 2021 07:23:11 +0000 (15:23 +0800)]
Fix a spell miss of document.

Bug-AGL:SPEC-4188

Signed-off-by: Qiu Tingting <qiutt@fujitsu.com>
Change-Id: I25be4702acb64be59b9d79cf5a46354c8302ea8e
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27051
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoModify document of 2_Creating_a_New_Service 52/26952/2
duerpei [Thu, 2 Dec 2021 02:06:31 +0000 (10:06 +0800)]
Modify document of 2_Creating_a_New_Service

Bug-AGL: SPEC-4162

Change-Id: I07f8bda958b86ec5d472e71d63ab30aa9df4c378

Signed-off-by: duerpei <duep.fnst@fujitsu.com>
Change-Id: Ie0b8eae61ac6bf0e5d44756b1221576e29602102
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26952
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoUpdate Renesas documentation following new BSP 80/26880/2
Frederic Marec [Mon, 22 Nov 2021 11:11:27 +0000 (12:11 +0100)]
Update Renesas documentation following new BSP

Bug-AGL: SPEC-4147

Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
Change-Id: I54180e050e1884511eb83957be4bc82be2216e62
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26880
Reviewed-by: Naoto YAMAGUCHI <naoto.yamaguchi@aisin.co.jp>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoRenesas: Add bitbake command each target 31/26731/4
Ronan Le Martret [Fri, 8 Oct 2021 09:38:05 +0000 (11:38 +0200)]
Renesas: Add bitbake command each target

Bug-AGL: SPEC-4024

Signed-off-by: Harunobu Kurokawa <harunobu.kurokawa.dn@renesas.com>
Signed-off-by: Ronan Le Martret <ronan.lemartret@iot.bzh>
Change-Id: I5b4cb25b3be70040a6c206ca7b6409bc2419c971
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26731
Reviewed-by: Naoto YAMAGUCHI <naoto.yamaguchi@aisin.co.jp>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2 years agoRenesas: Add Build Environment Insrument Cluster 30/26730/4
Ronan Le Martret [Fri, 8 Oct 2021 09:37:48 +0000 (11:37 +0200)]
Renesas: Add Build Environment Insrument Cluster

Bug-AGL: SPEC-4024

Signed-off-by: Harunobu Kurokawa <harunobu.kurokawa.dn@renesas.com>
Change-Id: Ic7dcb520d48d64b4b880ec9bb767ca863f176af9
Signed-off-by: Ronan Le Martret <ronan.lemartret@iot.bzh>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26730
Reviewed-by: Naoto YAMAGUCHI <naoto.yamaguchi@aisin.co.jp>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agorenesas: refactoring documentation 27/26627/5 12.90.1 marlin/12.90.1 marlin_12.90.1
Frederic Marec [Fri, 10 Sep 2021 13:14:17 +0000 (15:14 +0200)]
renesas: refactoring documentation

Change title to avoid its presence twice
Move some parts to troubleshooting
Change numerotation

Bug-AGL: SPEC-4074

Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
Change-Id: I598cdabfab5ebec9230e5fd9353521897cc152d6
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26627
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Reviewed-by: Harunobu Kurokawa <harunobu.kurokawa.dn@renesas.com>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years ago0_AGL_components: Provide some structure to the AGL developed compoments 69/26669/3
Marius Vlad [Thu, 23 Sep 2021 13:17:59 +0000 (16:17 +0300)]
0_AGL_components: Provide some structure to the AGL developed compoments

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: I9a50754bfeb19b74e5b31a58b55f1ff3f4f766ce
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26669
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agodocs/5_Component_Documentation/1_agl-compositor: Slash headers 68/26668/3
Marius Vlad [Thu, 23 Sep 2021 14:49:03 +0000 (17:49 +0300)]
docs/5_Component_Documentation/1_agl-compositor: Slash headers

mkdocs doesn't generate links for Header 3 types, so use Header 2
to have more links available, in case these might be needed.

Change-Id: I33c5e0bf5bcd74835f49ca7cd599753335b015ac
Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26668
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agodocs/5_Component_Documentation/1_agl-compositor: Update agl-compositor docs 67/26667/3
Marius Vlad [Thu, 23 Sep 2021 12:52:07 +0000 (15:52 +0300)]
docs/5_Component_Documentation/1_agl-compositor: Update agl-compositor docs

Include some examples on how to associate touch input devices with
multiple outputs.

Bug-AGL: SPEC-3836

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: Ib71bf8db8e349d8a4a2caf52e450e8a70bbf1f04
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26667
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agodocs: add a design document for the "IC sound manager" setup 63/26663/2
George Kiagiadakis [Mon, 20 Sep 2021 16:59:08 +0000 (19:59 +0300)]
docs: add a design document for the "IC sound manager" setup

Bug-AGL: SPEC-4027
Signed-off-by: George Kiagiadakis <george.kiagiadakis@collabora.com>
Change-Id: I3059c81f13c359e7af10089f102e811c94814e99
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26663
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoRBA docs: Update step to generate .json from .rba file 72/26672/2
Anusha Gugale [Mon, 27 Sep 2021 09:39:31 +0000 (15:09 +0530)]
RBA docs: Update step to generate .json from .rba file

Signed-off-by: Anusha Gugale <external.agogale@jp.adit-jv.com>
Change-Id: Id8a966014b58d9369f50bca7144c40f69b79939f
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26672
Reviewed-by: Naohiro Nishiguchi <nnishiguchi@jp.adit-jv.com>
Reviewed-by: Kenji Hosokawa <khosokawa@jp.adit-jv.com>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdded RBA tool documentation 41/26541/4
Anusha Gugale [Mon, 26 Jul 2021 17:54:38 +0000 (23:24 +0530)]
Added RBA tool documentation

Syntax of .rba file

Bug-AGL: SPEC-3947

Signed-off-by: Anusha Gugale <external.agogale@jp.adit-jv.com>
Change-Id: Ibac6b1a38a1ed2a149cf4e45fad180d427d8e174
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26541
Reviewed-by: Kenji Hosokawa <khosokawa@jp.adit-jv.com>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Reviewed-by: Naohiro Nishiguchi <nnishiguchi@jp.adit-jv.com>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoUpdate file link for h3ulcb on master 03/26503/2
Jan-Simon Möller [Wed, 14 Jul 2021 18:01:27 +0000 (20:01 +0200)]
Update file link for h3ulcb on master

Update the filename and add note on accelerated gfx.

Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
Change-Id: I042fb73bfeeca7235c8b281997656cd55795dc1b
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26503

3 years agoMore docs in 7_pyagl.md 89/26489/2
Edi Feschiyan [Wed, 7 Jul 2021 11:49:10 +0000 (14:49 +0300)]
More docs in 7_pyagl.md

Adding the rest of PyAGL documentation for mkdocs,
this commit should be a relatively complete documentation for pyagl

Bug-AGL: SPEC-3949
Signed-off-by: Edi Feschiyan <edi.feschiyan@konsulko.com>
Change-Id: I631ca03a57faac0b6285193d7f7d877dfed4374d
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26489
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdd initial DRM Lease Manager documentation 50/26450/2 12.90.0 marlin/12.90.0 marlin_12.90.0
Damian Hobson-Garcia [Thu, 24 Jun 2021 03:53:40 +0000 (12:53 +0900)]
Add initial DRM Lease Manager documentation

AGL-BUG: SPEC-3948
Signed-off-by: Damian Hobson-Garcia <dhobsong@igel.co.jp>
Change-Id: Icdcb1e63bd5d4b456f81a4b495e10e97dd3d42ef
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26450
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agodocs: add basic pipewire/wireplumber documentation 48/26448/2
George Kiagiadakis [Tue, 22 Jun 2021 15:16:10 +0000 (18:16 +0300)]
docs: add basic pipewire/wireplumber documentation

Bug-AGL: SPEC-3950
Signed-off-by: George Kiagiadakis <george.kiagiadakis@collabora.com>
Change-Id: Iaf68d263114c34944eca28507c8521a9c8d5d51d
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26448
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoupdate test sample command for pyagl test doc 20/26420/2 11.92.0 lamprey/11.92.0 lamprey_11.92.0
liuyahui [Tue, 8 Jun 2021 02:58:34 +0000 (10:58 +0800)]
update test sample command for pyagl test doc

Bug-AGL: SPEC-3973

Signed-off-by: liuyahui <liuyh.fnst@fujitsu.com>
Change-Id: Ifcafa2a8fb30696410af15b81b6022756fa736b4
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26420
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdding preliminary pyagl documentation 91/26391/2
Edi Feschiyan [Fri, 4 Jun 2021 16:37:24 +0000 (19:37 +0300)]
Adding preliminary pyagl documentation

Adding first bits of official pyagl documentation

Bug-AGL: SPEC-3949
Signed-off-by: Edi Feschiyan <edi.feschiyan@konsulko.com>
Change-Id: I0382ebb6c32ca2021d050e64c453ed970eab7a6d
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26391
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoUpdate irc and quickstart links 92/26392/2
Jan-Simon Möller [Sun, 6 Jun 2021 20:44:15 +0000 (22:44 +0200)]
Update irc and quickstart links

We're moving to irc.libera.chat, thus change this on the doc site as well.
Also update the mailinglist and contribution links.

Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
Change-Id: I3464eab8928123491542a27fc350281b6a75b45f
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26392
Reviewed-by: Walt Miner <walt@linux.com>
3 years agoFix branch name from jellyfish to koi in the document of koi release 62/26162/2 11.91.0 lamprey/11.91.0 lamprey_11.91.0
Naoto YAMAGUCHI [Tue, 16 Mar 2021 13:40:27 +0000 (22:40 +0900)]
Fix branch name from jellyfish to koi in the document of koi release

When the agl developer create agl source tree of koi release using repo,
they create jellyfish source tree.  Because the document of koi has incorrect
description for repo command example.
This patch fix to this issue.

Signed-off-by: Naoto YAMAGUCHI <i33399_YAMAGUCHI@aisin-aw.co.jp>
Change-Id: I0b7d3fe76c38383eed291bd1c78c74bf20c998ca
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26179
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
(cherry picked from commit 43c8b7cdb0662e738ea6eb9ecfa72ca3437b2aee)
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26162

3 years ago[Renesas] Update Renesas bsp version 49/26149/3
Frederic Marec [Tue, 9 Mar 2021 14:33:20 +0000 (15:33 +0100)]
[Renesas] Update Renesas bsp version

Bug-AGL: SPEC-3804

Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
Change-Id: I230f65a21fc21bccf0ff41f97b30962493c26e81
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26149
Reviewed-by: Harunobu Kurokawa <harunobu.kurokawa.dn@renesas.com>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agodocs/2_waltham-receiver_waltham-transmitter: Added waltham documentation 37/26137/2
Marius Vlad [Fri, 5 Mar 2021 13:46:14 +0000 (15:46 +0200)]
docs/2_waltham-receiver_waltham-transmitter: Added waltham documentation

Bug-AGL: SPEC-3777

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: I022c24b18b247df97f0c5781545e1ffb06656e3e
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26137
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years ago1_agl-compositor: Mention agl-shell-app-id for migrating apps 36/26136/2
Marius Vlad [Thu, 4 Mar 2021 12:35:19 +0000 (14:35 +0200)]
1_agl-compositor: Mention agl-shell-app-id for migrating apps

Besides using the agl-shell-desktop protocol one can use agl-shell-app-id
to migrate surfaces to other local, or remote outputs.

Bug-AGL: SPEC-3820

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: Ifdb5853a9a3eaf9dc041d68596c353548437c64b
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26136
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdd documentation on how to add a LAVA lab 39/26139/2
Jan-Simon Möller [Fri, 5 Mar 2021 17:39:16 +0000 (18:39 +0100)]
Add documentation on how to add a LAVA lab

Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
Change-Id: I3a70e7dcfd4e517256dff3b167139cecb0476f4f
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/26139

3 years agoMention virtio-aarch64 machine among supported hardware. 66/25966/6
Vasyl Vavrychuk [Tue, 26 Jan 2021 14:44:27 +0000 (16:44 +0200)]
Mention virtio-aarch64 machine among supported hardware.

Bug-AGL: SPEC-3778
Change-Id: I6bfedb55b22e484e9d00f42eb7f5feee0175b1ff
Signed-off-by: Vasyl Vavrychuk <vasyl.vavrychuk@opensynergy.com>
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25966
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdd getting started document for virtio machine. 65/25965/6
Vasyl Vavrychuk [Tue, 26 Jan 2021 14:43:27 +0000 (16:43 +0200)]
Add getting started document for virtio machine.

Prepared it based on 5_1_x86_Emulation_and_Hardware.md file.

Bug-AGL: SPEC-3778
Signed-off-by: Vasyl Vavrychuk <vasyl.vavrychuk@opensynergy.com>
Change-Id: I1688b4e24a18b0d33f008085c90411723a29b76a
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25965
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoREADME.md: Remove sudo usage. 68/25968/5
Vasyl Vavrychuk [Tue, 26 Jan 2021 01:23:52 +0000 (03:23 +0200)]
README.md: Remove sudo usage.

It is more common to use pip without sudo.

Also, no reason to use sudo with 'mkdocs serve'.

Bug-AGL: SPEC-3778
Signed-off-by: Vasyl Vavrychuk <vasyl.vavrychuk@opensynergy.com>
Change-Id: Ic4e2b34da98b0f036c34f253c0f0aeea150db443
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25968
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdapt instructions for VirtualBox 88/25988/2
Jan-Simon Möller [Tue, 2 Feb 2021 17:51:39 +0000 (18:51 +0100)]
Adapt instructions for VirtualBox

This is due to https://www.virtualbox.org/ticket/19873?cversion=0&cnum_hist=4

Adapt the documentation to deal with the resolution issue.

Bug-AGL: SPEC-3731
Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
Change-Id: I6ff56593d1064d44dc5ab972d8e3475003a91f36
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25988

3 years agoGeneric updates to the documentation matching master and koi 86/25986/2
Jan-Simon Möller [Tue, 2 Feb 2021 17:30:26 +0000 (18:30 +0100)]
Generic updates to the documentation matching master and koi

Mostly updates to the yocto links or adding the refhw.

Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
Change-Id: Ib28bd5de72e7be8b2a2605e8149143fb946a7b69
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25986

3 years agoFix documentation CSS style 64/25964/2
Frederic Marec [Tue, 26 Jan 2021 13:33:44 +0000 (14:33 +0100)]
Fix documentation CSS style

Specify display for summary tag for firefox

Bug-AGL: SPEC-3708

Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
Change-Id: Ic290665c4ecf8e2060eb11162839b9ca6275cb3c
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25964
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdd AGL docs page to make a custom recipe 07/25907/2
Thomas Walzer [Wed, 13 Jan 2021 18:24:52 +0000 (19:24 +0100)]
Add AGL docs page to make a custom recipe

This docs page shows how to add a custom recipe from a git-repo.
It shows how to do this step by step.
It was used to make the cannelloni recipe.

Bug-AGL: [SPEC-3768]

Signed-off-by: Thomas Walzer <thomas.walzer@reutlingen-university.de>
Change-Id: I306786bfc42aa64eb256259f61d0e402e23c37a2
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25907
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoChanged the folder names of pictures to images and changed the paths in the md files. 01/25901/2
Thomas Walzer [Wed, 13 Jan 2021 12:00:47 +0000 (13:00 +0100)]
Changed the folder names of pictures to images and changed the paths in the md files.

Signed-off-by: Thomas Walzer <thomas.walzer@reutlingen-university.de>
Change-Id: Idd44284f082c427ee5f6245465009c9a89539922
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25901
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdded Create a Custom Recipe 99/25899/2
Thomas Walzer [Wed, 13 Jan 2021 11:45:36 +0000 (12:45 +0100)]
Added Create a Custom Recipe

Signed-off-by: Thomas Walzer <thomas.walzer@reutlingen-university.de>
Change-Id: Ice9a0c4bf385e4a2af5c0e88a1c0d18a1c6ceb74
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25899
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoDocument AGL Reference Hardware 57/25957/2 10.93.0 koi/10.93.0 koi_10.93.0
Scott Murray [Thu, 21 Jan 2021 19:43:43 +0000 (14:43 -0500)]
Document AGL Reference Hardware

Add AGL Reference Hardware configuration to the Renesas board
documentation.

Bug-AGL: SPEC-3708

Signed-off-by: Scott Murray <scott.murray@konsulko.com>
Change-Id: I48c852ec2ee880cae121a7d3368f5a127bcf2d9b
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25957
Reviewed-by: Fr�d�ric Marec <frederic.marec@iot.bzh>
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoFix formatting issues in Renesas board markdown 56/25956/2
Scott Murray [Thu, 21 Jan 2021 19:09:47 +0000 (14:09 -0500)]
Fix formatting issues in Renesas board markdown

Changes:
- python-markdown is particular about indentation being 4 spaces
  for lists, fix various indentation so that the generated page
  has properly numbered lists and indentation levels.
- Replace some remaining XML markup that was breaking the page
  rendering with code blocks.  This fixes the U-Boot output examples.
- Simplify the indentation in section 11 by using section headers
  for the multimedia and ICCOM information instead of a list.
  This avoids a lot of extra indentation in the markdown and wastes
  less horizontal space on the generated page.
- Add a couple more elinux.org links where it seemed appropriate.
- Tweak wording in a couple of spots to read better.

Bug-AGL: SPEC-3708

Signed-off-by: Scott Murray <scott.murray@konsulko.com>
Change-Id: I6b643804b11ee7dae11a7a5569abe57337270f86
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25956
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years ago1_agl-compositor.md: Added initial docs for agl-compositor 58/25958/2
Marius Vlad [Thu, 21 Jan 2021 11:58:26 +0000 (13:58 +0200)]
1_agl-compositor.md: Added initial docs for agl-compositor

Contains some project history, and some Wayland introduction.  Goes a
bit explaining the private extensions, the toolkit platforms supported
and some explanation of policy engines and policies. Some
particularities to the agl-compositor been described as well.

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: I444144dba024643c0fe639bff2a11ca8f77df8c4
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25958
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdd a category for agl-compositor and rba documentation 13/25913/3
Jan-Simon Moeller [Thu, 14 Jan 2021 17:18:25 +0000 (18:18 +0100)]
Add a category for agl-compositor and rba documentation

Create a home for docs of compositor, rba and pipewire/wireplumber.
Also add a .gitignore file.

Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Change-Id: Id1f9812d0f4db83cb72bf03987dc95d754e00725
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25913

3 years agoRemoved redundant directory in APIs and Services 68/25668/2 10.91.0 10.92.0 koi/10.91.0 koi/10.92.0 koi_10.91.0 koi_10.92.0
Shankho Boron Ghosh [Sun, 29 Nov 2020 23:39:36 +0000 (05:09 +0530)]
Removed redundant directory in APIs and Services

Bug-AGL: [SPEC-3633]

Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: Id7ac2ae56db00325df1782d9ec0ab82caebfb0b2
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25668
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoLink Fix 67/25667/3
Shankho Boron Ghosh [Sun, 29 Nov 2020 23:08:44 +0000 (04:38 +0530)]
Link Fix

Corrected internal link in documentation homepage.

Bug-AGL: [SPEC-3633]

Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: Id73010b73d4fb56824642b510e9d4434466b194d
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25667
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>