summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2019-07-20audio: add documentation for the pipewire stackGeorge Kiagiadakis1-0/+176
Signed-off-by: George Kiagiadakis <george.kiagiadakis@collabora.com>
2019-07-09API Reference Links updatedScott Rifenbark1-29/+29
I updated all the links on the "Available APIs" page to go to an "about" page when possible. Of the list, most can be linked to a human-readable "about" page. Some cannot. I left the ones that cannot go to a readable page alone. These still go to the repository view. This fix is for "master" only so far. See https://jira.automotivelinux.org/browse/SPEC-2606?page=com.atlassian.jira.plugin.system.issuetabpanels%3Aall-tabpanel Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-06-26Fix issue on docs.automotivelinux.orgAdam Parker1-0/+4
Formatting on docs.automotivelinux.org does not separate lines of environment commands.
2019-06-08Getting Started -> debug app: Fixed topic titleScott Rifenbark1-1/+1
I updated the target topic title of a link to have "XDS" in it to match reality. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-06-08Getting Started -> debug app: General edits.Scott Rifenbark1-9/+17
I updated content so the links target topic name actually matches the target topic title. Also, used the box formatting for a couple notes. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-05-28getting-started/machines/renesas: update referencesStephane Desneux2-39/+33
New BSP and drivers for AGL/master (and upcoming AGL/HH) need to be updated. Change-Id: I019ab21f3e6665dbec5083a1df1e1682bbe524e3 Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
2019-05-24R-Car build: Add a step to explain the Rcar graphic hotfixPierre MARZIN1-0/+11
Add a temporary paragraph to explain how to setup AGL build in order to correctly use the hotfix graphic patch (see commit 9bc6c25f5 on master/meta-agl). Warning: This section will have to be removed when the corresponding patch will be reverted. Bug-AGL: SPEC-2253 Signed-off-by: Pierre MARZIN <pierre.marzin@iot.bzh>
2019-05-06Fixed links in "Debug the Application" section.Scott Rifenbark1-3/+3
The links in this section need to resolve to new files in the XDS section. I updated the links. There could be some overlap where the links do not work if a review for the xds-docs repo is not merged. That outstanding review is for the renaming of the files. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-05-06Fixed links in "Create and Build the Application" sectionScott Rifenbark1-3/+3
Links in this section of the "Getting Started" area were referencing old file names. I have fixed these links. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-05-06Fixed broken links in "Get Ready to Create your Application"Scott Rifenbark1-5/+5
Links adjusted for differently named files. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-05-06getting-started/renesas: adjustments after migration to ThudStephane Desneux1-7/+9
* fix markdown syntax * adjust DTB filenames in uboot config examples Bug-AGL: SPEC-1838 Change-Id: Ic26e04adcadd7d5825423ad60a0393f8a74bab40 Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
2019-04-16handle-docs: add "how to handle documentation"Clément Bénier4-30/+124
Change-Id: I309c44bc2199b330264e061367d57a4de41d4fbb Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-04-16app-workflow-deploy-app: fix broken linkClément Bénier1-1/+1
Change-Id: I50a0a06c8f1cb0ba95da6419651b24eadfa60051 Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-04-15app-workflow-debug-app: fix broken linksClément Bénier1-3/+3
Change-Id: If979579933408beb9ac4383659766c3bd4ec96eb Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-04-15app-workflow-deploy-app: fix broken linkClément Bénier1-1/+1
Change-Id: I66054c45b9f70ca3db3b4a1a739498361a55529b Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-04-15app-workflow-build-app: fix broken linksClément Bénier1-3/+3
Change-Id: I963f5ec2e2fb02a5feb2e3a65f732747a92b3188 Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-04-15app-workflow-prep-app: fix broken linksClément Bénier1-1/+1
Change-Id: Ie2ed6d694506ac6bbc84e602ba94d998a27f65e1 Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-04-15machines/renesas: fix broken linkClément Bénier2-6/+6
Change-Id: I92b239f38ce82bed3305b98f26d5de1fb0c31c0d Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-04-08API Reference: Added files to support API reference overview.Scott Rifenbark2-0/+59
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-03-29Merge remote-tracking branch 'origin/master-next'Clément Bénier43-769/+3526
Change-Id: Ifda0fa9a9940d056f72bcad0ea94821face3685d
2019-03-28Removed WRITER'S NOTES.Scott Rifenbark4-35/+1
I took out some remaining WRITER'S NOTES from four of the *.md files. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-03-25getting-started: Add new titles to improve readingPierre MARZIN1-2/+4
2019-03-25getting-started: machines: Fix broken linksPierre MARZIN3-7/+7
2019-03-19R-Car Build: Update build docPierre MARZIN1-6/+7
2019-03-19getting-started: Fix some errorsPierre MARZIN2-6/+6
image-workflow-intro.md: Correct image link image-workflow-build.md: Fix broken links
2019-03-19R-Car build: Fix broken linksPierre Marzin1-4/+4
2019-03-19Update RCAR BSP version on AGLronan [iot.bzh]1-1/+2
2019-03-19Update RCAR GEN3 BSP version on AGLronan [iot.bzh]1-1/+2
2019-02-25Add new book.yml for Security BlueprintSebastien Douheret1-0/+116
Change-Id: I0565d1e9b668c4b493573692ad9f44b5c9548893 Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2019-02-24handle-docs-book: book for handling docsClément Bénier1-0/+13
Change-Id: I41c773681488f25811b8cf44a3b173291fb013c6 Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-02-24getting started book: updatedClément Bénier1-12/+18
Change-Id: Ia06214fb5209cf3456f3bba559685f8aefea061f Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-02-24book for continuous integrationClément Bénier1-0/+9
Change-Id: I39bd2c0b60619e773680d7884ca6a5a2007a6304 Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-02-14books: fix hierarchical errors and add new oneClément Bénier3-4/+11
- add new one for hmi-framework Change-Id: Ie84fc486a505d7d5f3954cd54a32524b839b716d Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-02-13docs: add yaml bookFrederic Marec2-0/+26
Bug-AGL: SPEC-1988 Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
2019-02-13Fix images link (markdown syntax)Sebastien Douheret1-3/+2
Change-Id: I22201168f30077f69abcbf46d753f75e0509b715 Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2019-02-13Fix renesas.md filename and remove authorSebastien Douheret1-6/+4
Change-Id: I6e4335d71084b2af4157bcce0a14516a0912f107 Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2019-02-13Remove useless reference to %lang%Sebastien Douheret1-25/+24
Change-Id: I91e0ef7a2eb09e841da43f917ea661cef0c06556 Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2019-02-13yml book: remove language from bookClément Bénier1-10/+7
Change-Id: I3c3135465bb782ea3ba579118118b1594fd2825f Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-01-29handle-doc: add a scheme into documentationClément Bénier3-2/+38
Change-Id: I56e2c81f98c5cab1564fc5463154156c60aa0b71 Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-01-29handle-docs: add more details about book.yml workflowSebastien Douheret2-27/+49
Change-Id: I47fb5bedf6d1e70c0f5e2607bf67b3947b210b1c Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
2019-01-29handle doc: add workflow pictureClément Bénier2-0/+0
add workflow picture for handle doc Change-Id: Icded1cd1f26556de0d9fdb3eaecc79c058ad71f9 Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2019-01-29handle-docs: add documentation for book worflowClément Bénier2-0/+172
Change-Id: I893751d12cb787861a4fbac03ebe463b22a07bc8 Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
2018-12-27Intel Builds: Updated with info about 'xattrs'Scott Rifenbark1-4/+25
I put information in about the Extended Attributes. These are handled when a user uses the scripts provided by AGL to copy the image to media. Not so if the user uses 'tar'. Information provided explaining that situation. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-12-27Extended Attributes: Re-write of xattrs informationScott Rifenbark1-28/+49
This section is about how to include xattrs when you create bootable media using 'tar'. For now, it remains in the "Troubleshooting" section. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-12-21Welcome: I added a new "Welcome" sectionScott Rifenbark1-0/+79
This is landing point content for what we currenly have as the "Getting Started". The content overviews AGL and provides some reader roadmap for the "Getting Started" items. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-12-21Docker Container Setup: Mods to give this an overviewScott Rifenbark1-1/+1
Modifications to structure the first item as "Overview" This gives some parallel structure to the "Getting Started" material. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-12-21Troubleshooting: Removed the mega-rust "bug" information.Scott Rifenbark1-0/+14
This content was dated. The issue is now fixed and the error should not be seen going forward. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-12-17Raspberry PI build: Integrated old debug stuff into main build.Scott Rifenbark4-57/+48
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-12-17Building for Raspberry PI: Added touchscreen configuration info.Scott Rifenbark1-2/+76
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-12-11Intel-footer.md: Removed.Scott Rifenbark1-90/+0
Information merged into the main building for Intel devices topic. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>