Skip to content

Commit

Permalink
Update main documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Aug 9, 2024
1 parent c1dfd9e commit e105eea
Show file tree
Hide file tree
Showing 20 changed files with 623 additions and 405 deletions.
2 changes: 1 addition & 1 deletion main/examples/html/footer.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
function writeFooter() {
document.write('Generated on Tue Jul 23 2024 15:16:32 for Examples Version 2.0.0 by Arm Ltd. All rights reserved.');
document.write('Generated on Fri Aug 9 2024 08:50:17 for Examples Version 2.0.0 by Arm Ltd. All rights reserved.');
};
4 changes: 2 additions & 2 deletions main/examples/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,11 +128,11 @@
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Example </th><th class="markdownTableHeadLeft">Description </th><th class="markdownTableHeadLeft">Repository </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">Visual Studio Code get started solution </td><td class="markdownTableBodyLeft">Hello world example for AVH FVPs with support of GitHub Actions for build and run </td><td class="markdownTableBodyLeft"><a href="https://github.com/Open-CMSIS-Pack/vscode-get-started">github.com/Open-CMSIS-Pack/vscode-get-started</a> </td></tr>
<td class="markdownTableBodyLeft">AVH-Hello </td><td class="markdownTableBodyLeft">Hello world example for AVH FVPs with support of GitHub Actions for build and run </td><td class="markdownTableBodyLeft"><a href="https://github.com/Arm-Examples/AVH-Hello">github.com/Arm-Examples/AVH-Hello</a> </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">AVH_CI_Template </td><td class="markdownTableBodyLeft">Simple example with unit tests that shows the CI setup with AVH FVPs using GitHub Actions </td><td class="markdownTableBodyLeft"><a href="https://github.com/Arm-Examples/AVH_CI_Template">github.com/Arm-Examples/AVH_CI_Template</a> </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">Hello VSI Example </td><td class="markdownTableBodyLeft">Simple example that streams data from a file via Virtual Streaming Interface (VSI) </td><td class="markdownTableBodyLeft"><a href="https://github.com/Arm-Examples/Hello_AVH">github.com/Arm-Examples/Hello_AVH</a> </td></tr>
<td class="markdownTableBodyLeft">AVH-VSI Examples </td><td class="markdownTableBodyLeft">Simple examples that demonstrate use of Virtual Streaming Interface (VSI) in different use cases </td><td class="markdownTableBodyLeft"><a href="https://github.com/Arm-Examples/AVH-VSI">github.com/Arm-Examples/AVH-VSI</a> </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">AVH-MLOps </td><td class="markdownTableBodyLeft">A set of tools and software components and examples showcasing MLOps systems with AVH FVPs </td><td class="markdownTableBodyLeft"><a href="https://github.com/ARM-software/AVH-MLOps">github.com/ARM-software/AVH-MLOps</a> </td></tr>
<tr class="markdownTableRowOdd">
Expand Down
2 changes: 1 addition & 1 deletion main/infrastructure/html/avh_gh_actions.html
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ <h1><a class="anchor" id="avh_gh_run"></a>
<div class="line"> target: [CS315, CS310, CS300]</div>
<div class="line"> compiler: [AC6, GCC, Clang]</div>
</div><!-- fragment --><p>And then in your job descriptions you can use <code>${{ matrix.target }}</code> and <code>${{ matrix.compiler }}</code> variables, that GitHub Actions will automatically iterate over for you.</p>
<p>See <a href="https://github.com/ARM-software/CMSIS-RTOS2_Validation/blob/15c0fbfaf4302af39a8144bca8dbb7b1f04fce1a/.github/workflows/cmsis_rv2.yml#L131">CMSIS-RTOS2_Validation project</a> as an implementation example where such matrix strategy is implemented for API verification over different RTOS kernels and with different toolchains.</p>
<p>See <a href="https://github.com/Arm-Examples/AVH-Hello">AVH-Hello</a>) as a simple example where such matrix strategy is implemented for building the program with different toolchain and for running on different AVH FVP targets.</p>
<p>Note that use of <a href="https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/YML-Input-Format.md">csolution project format</a> greatly simplifies project definition and build for different target types and build configurations. It well integrates with the GitHub Actions matrix for CI jobs.</p>
<h1><a class="anchor" id="avh_ci_template"></a>
Example Template</h1>
Expand Down
2 changes: 1 addition & 1 deletion main/infrastructure/html/footer.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
function writeFooter() {
document.write('Generated on Tue Jul 23 2024 15:16:32 for Infrastructure Version 2.0.0 by Arm Ltd. All rights reserved.');
document.write('Generated on Fri Aug 9 2024 08:50:17 for Infrastructure Version 2.0.0 by Arm Ltd. All rights reserved.');
};
7 changes: 5 additions & 2 deletions main/overview/html/Development_Workflow.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,11 @@
<h1><a class="anchor" id="CI_workflow"></a>
Continuous Integration (CI)</h1>
<p>New functionality can be quickly developed on a simulation model with frequent changes being automatically verified upon the code commits to a cloud based version control system such as GitHub which executes a complete CI/CD integration flow. Figure below illustrates the concept.</p>
<p><img src="./images/basic_ci_workflow.png" alt="Continuous Integration (CI) workflow" title="Continuous Integration (CI) workflow" class="inline"/></p>
<ol type="1">
<div class="image">
<img src="basic_ci_workflow.png" alt=""/>
<div class="caption">
Continuous Integration (CI) workflow</div></div>
<ol type="1">
<li><b>Local development</b> is done by engineers on local machines using common embedded tools such as Keil MDK with AVH FVP models used for MCU simulation. See <a href="../../infrastructure/html/avh_desktop.html">AVH FVPs on Desktop</a> for details. The software can also be already prepared for real hardware as explained in <a class="el" href="Development_Workflow.html#Physical_Hardware">Migration to Physical Hardware</a>.</li>
<li><b>Code repository</b> is used as a source code management system for synchronization, storage and version control. For example GitHub.</li>
<li><b>CI pipeline</b> implements the Continuous Integration flow (for example GitHub Actions) that gets triggered on every code update in the target repository.</li>
Expand Down
Binary file added main/overview/html/basic_ci_workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion main/overview/html/footer.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
function writeFooter() {
document.write('Generated on Tue Jul 23 2024 15:16:32 for Overview Version 2.0.0 by Arm Ltd. All rights reserved.');
document.write('Generated on Fri Aug 9 2024 08:50:17 for Overview Version 2.0.0 by Arm Ltd. All rights reserved.');
};
Loading

0 comments on commit e105eea

Please sign in to comment.