AGL/documentation.git
3 years agoAdded Architecture Guide Overview & Specification 04/25604/5
Shankho Boron Ghosh [Thu, 19 Nov 2020 12:30:41 +0000 (18:00 +0530)]
Added Architecture Guide Overview & Specification

Rewrote Architecture Guide Overview and meta-refreshed specification
to refer https://www.automotivelinux.org/wp-content/uploads/sites/4/2017/08/agl_spec_v1_280515.pdf

v2 : Resolved merge conflict.

v3 : Removed swap file and added use cases.

v4 : Resolved merge conflict

Bug-AGL: [SPEC-3633]

Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: Ie9f8f88f4ce363563078ebcc0fafedfb0cdb10fe
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25604
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoRevision of Architecture Guides 02/25602/2
Shankho Boron Ghosh [Wed, 18 Nov 2020 14:25:02 +0000 (19:55 +0530)]
Revision of Architecture Guides

v1:
Introduction : Skeleton file of Build Process [WIP].
Security Blueprint : Multiple markdowns appended into single markdown.
v2:
Security Blueprint :
4_Kernel.md - Fixed Internal Link.
Annexes.md - Uniform markdown Title.

Bug-AGL: [SPEC-3633]

Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: I1ab478348a05464612d67f0e8a4570bda309022d
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25586
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
(cherry picked from commit 9cc56459419f1225f5e9851825ad305424b3d6fb)
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25602

3 years agoGeneral Guidelines : DCO adherence 03/25603/2
Shankho Boron Ghosh [Wed, 18 Nov 2020 18:33:44 +0000 (00:03 +0530)]
General Guidelines : DCO adherence

Mentioned DCO in legal stuff section.

Bug-AGL: [SPEC-3633]

Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: Ifbbae95196ce6db1b7d3ad32f9c46ac4c727dacd
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25603
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoFIX : Internal Links 01/25601/3
Shankho Boron Ghosh [Wed, 18 Nov 2020 15:47:59 +0000 (21:17 +0530)]
FIX : Internal Links

Minor fix of internal links.
v2 : Fix merge conflict.

Bug-AGL: [SPEC-3633]

Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: I689193817da24c9bfb8fcea9fd6b497cda58ab76
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25588
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
(cherry picked from commit 43a9d93a4c79fecd2d643e1fa333a6683443e628)
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25601

3 years agoContribution Checklist : Minor Nesting 00/25600/2
Shankho Boron Ghosh [Wed, 18 Nov 2020 15:33:07 +0000 (21:03 +0530)]
Contribution Checklist : Minor Nesting

Indentation added for proper nesting of checklist points.

Bug-AGL: [SPEC-3633]

Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: I47dfc52805b1aff4cfdf3dee0287fffafbbe0a03
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25600
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdded Contribution Checklist 99/25599/2
Shankho Boron Ghosh [Mon, 16 Nov 2020 14:28:11 +0000 (19:58 +0530)]
Added Contribution Checklist

Added comprehensive tasklist as a guideline for contributions in How
To Contribute section. Also, minor fixup of API reference :
0_api-introduction.

v2: Added item : Is a backport to a release branch required ?

Bug-AGL: [SPEC-3633]

Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: I122f2093bd8360be4082497e0cadb67ca67d6d4e
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25580
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
(cherry picked from commit c04ab11b946684902e3e39aef475a2d16c09e1c4)
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25599

3 years agoAdded APIs introduction 98/25598/2
Shankho Boron Ghosh [Fri, 13 Nov 2020 15:20:03 +0000 (20:50 +0530)]
Added APIs introduction

Adding old api introduction page.

v2: Adding only 4.1 : Introduction

Bug-AGL: [SPEC-3633]

Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: Ibdabddccd73c1230c1b78c71c2cea4c5542b4a9b
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25558
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
(cherry picked from commit 2357897252c1fc3fd082113179bafb1e08b0d7ac)
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25598

3 years agoUpdated Quickstart qemu launch instructions. 96/25596/2
Shankho Boron Ghosh [Mon, 16 Nov 2020 14:47:26 +0000 (20:17 +0530)]
Updated Quickstart qemu launch instructions.

Added -vga virtio to qemux86 doc.

Bug-AGL: [SPEC-3633]

Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: I116fc5ac529d1ec0564f6a5f1e269a86837bb0c0
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25581
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
(cherry picked from commit 991c6f12d7814c698d75e76cb5fdab965a2eeef0)
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25596

3 years agoAdded [in-progress] Developer Guides 46/25546/2
Shankho Boron Ghosh [Fri, 30 Oct 2020 04:53:28 +0000 (10:23 +0530)]
Added [in-progress] Developer Guides

Updated mkdocs.yml, README.md.
Text wrap markdowns at 80.

Cherry-pick from master

Bug-AGL: [SPEC-3633]

Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: I2d7b43cb870e97786d3eb101c60a2071cc50f0be
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25498
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/+/25546

3 years agoAdded Contribution Guide 93/25393/2
Shankho Boron Ghosh [Thu, 22 Oct 2020 18:40:00 +0000 (00:10 +0530)]
Added Contribution Guide

Exhaustive Contribution Guide. Removed Trailing Whitespaces.
Updated index.md. Abandoned accidental commits 25474,
25474 and uploading a new patchset. Corrected code renderings.

v2 (jsmoeller): Update contribution subchapters

Bug-AGL: SPEC-3633

Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: Ia808adc0208052f0591396860ac776e34070d279
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25473
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
(cherry picked from commit de81a8b07f8139fa0f65dddffc839b4a5e83dad7)
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25393

3 years agoRenesas: Fix renesas documentation 72/25472/5
Frederic Marec [Thu, 22 Oct 2020 16:05:34 +0000 (18:05 +0200)]
Renesas: Fix renesas documentation

Difference was done between old and new documentation
Keeping useful information from the old version
Adding new changes from the new one

Bug-AGL: SPEC-3666

Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
Change-Id: I8885ab8cb2f96ad76f83b1a4d83529a9a481607f
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25472
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdded Documentation for Jellyfish 11/25411/4
Jan-Simon Möller [Wed, 14 Oct 2020 11:26:09 +0000 (13:26 +0200)]
Added Documentation for Jellyfish

(rewrote majority of them and updated with minor changes)
(removed whitespaces, added contribution guide, corrected rcar-gen3 section 7, added aglsetup.h flags to hardware support, some minor changes)

Bug-AGL: [SPEC-3633]

Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: Ifd6b3c1cdaa41f05a74c1affe6db9e24763921b9
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25411
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdd gitreview file for jellyfish branch 10.0.0 jellyfish/10.0.0 jellyfish_10.0.0
Jan-Simon Möller [Tue, 15 Sep 2020 21:35:11 +0000 (23:35 +0200)]
Add gitreview file for jellyfish branch

Update the .gitreview file.

Bug-AGL: SPEC-3581
Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
3 years agoSimplified doc-site generation 36/25236/2 9.99.4 jellyfish/9.99.4 jellyfish_9.99.4
growupboron [Fri, 11 Sep 2020 11:48:57 +0000 (17:18 +0530)]
Simplified doc-site generation

Updated theme to windmill Using Mkdocs static site generator Deployed on readthedocs

Signed-off-by: growupboron <shankhoghosh123@gmail.com>
Change-Id: If62eaaea1855c91b64f687900f54eba6bc1caee8
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25236
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdd gitreview file 35/25235/2
Jan-Simon Moeller [Fri, 11 Sep 2020 11:15:35 +0000 (13:15 +0200)]
Add gitreview file

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

3 years agoInitial empty repository
Jan-Simon Moeller [Thu, 27 Aug 2020 11:51:35 +0000 (11:51 +0000)]
Initial empty repository