AGL/documentation.git
3 years agoAdded Contribution Checklist 80/25580/3
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>
3 years agoUpdated Quickstart qemu launch instructions. 81/25581/5
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>
3 years agoAdded APIs introduction 58/25558/4
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>
3 years agoAdded [in-progress] Developer Guides 98/25498/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.

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>
3 years agoRenesas: Fix renesas documentation 71/25471/9
Frederic Marec [Thu, 22 Oct 2020 15:55:43 +0000 (17:55 +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

v2 (jsmoeller): keep in sync with other machines

Bug-AGL: SPEC-3666

Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
Change-Id: Ifa87dfa5ead453b0b994905e80989c6efae726db
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25471
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
3 years agoAdded Contribution Guide 73/25473/8
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>
3 years agoDo a fixed config for RTD
Jan-Simon Möller [Wed, 21 Oct 2020 10:48:15 +0000 (12:48 +0200)]
Do a fixed config for RTD

Signed-off-by: Jan-Simon Möller <jsmoeller@linuxfoundation.org>
Change-Id: Icd3fdbe08f63730c35325da74d5dae79b6ba37c9

3 years agorewrote quickstart, build-process 07/25407/7
growupboron [Thu, 8 Oct 2020 18:49:18 +0000 (00:19 +0530)]
rewrote quickstart, build-process

Revamped and updated documentation to install and build AGL images.
(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: Iedb6c7dc1661f4bc58b5f25ea5d188778c7ff908
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25407
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <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