Skip to content

Commit ebf16a1

Browse files
JoeOsterJoeOster
authored
Doc updates (oneapi-src#658)
* Update docs * updates * Update README.md * Update README.md * Update README.md * tool updates * Update README.md * Update content.json * grammer fix * Update README.md * Update third-party-programs.txt * Update third-party-programs.txt * Rename content.json to content.jso * Create content.json * misc * misc * misc * tpp updates
1 parent 227ffdf commit ebf16a1

File tree

10 files changed

+1979
-1223
lines changed

10 files changed

+1979
-1223
lines changed

‎.repo-tools/Docs_Automation/content.json

Lines changed: 33 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,33 @@
1-
{
2-
"mdLicense": "## License\n\nCode samples are licensed under the MIT license. See [License.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/License.txt) for details.\n\nThird-party program Licenses can be found here: [third-party-programs.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/third-party-programs.txt)",
3-
4-
"mdContribute": "## Contribute\n\nSee [CONTRIBUTING](https://github.com/oneapi-src/oneAPI-samples/blob/master/CONTRIBUTING.md) for more itargetedDevices.ormation.\n\n",
5-
6-
"mdIntro1":"The oneAPI samples repository provides code samples for Intel oneAPI toolkits.<br><br>We recommend checking out a specific stable release version of the repository. The version of the repository you fetch should match the version of the oneAPI compiler you are using. [View available stable releases](https://github.com/oneapi-src/oneAPI-samples/tags). ",
7-
"mdIntro2":"The latest versions (",
8-
"mdIntro2.1":") of code samples on the master branch are not guaranteed to be stable.",
9-
"mdIntro3":"The oneAPI sample repository is organized as follows:",
10-
"mdIntro3.1":"\n\n* [AI-and-Analytics:](https://github.com/oneapi-src/oneAPI-samples/tree/master/AI-and-Analytics)\n * [End-to-End-Workloads](https://github.com/oneapi-src/oneAPI-samples/tree/master/AI-and-Analytics/End-to-end-Workloads)\n * [Features-and-Functionality](https://github.com/oneapi-src/oneAPI-samples/tree/master/AI-and-Analytics/Features-and-Functionality)\n * [Getting-Started-Samples](https://github.com/oneapi-src/oneAPI-samples/tree/master/AI-and-Analytics/Getting-Started-Samples)\n",
11-
"mdIntro3.2":"* [DirectProgramming](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming)\n * [C++](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming/C%2B%2B)\n * [DPC++](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming/DPC%2B%2B)\n * [DPC++FPGA](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming/DPC%2B%2BFPGA)\n * [Reference Designs](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming/DPC%2B%2BFPGA/ReferenceDesigns)\n * [Tutorials](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming/DPC%2B%2BFPGA/Tutorials)\n * [Fortran](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming/DPC%2B%2BFPGA)\n",
12-
"mdIntro3.3":"* [Libraries](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries)\n * [oneCCl](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneCCL)\n * [oneDAL](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneDAL)\n * [oneDNN](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneDNN)\n * [oneDPL](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneDPL)\n * [oneMKL](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneMKL)\n * [oneTBB](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneTBB)\n * [oneVPL](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneVPL)\n",
13-
"mdIntro3.4":"* [Publications](https://github.com/oneapi-src/oneAPI-samples/Publications/)\n * [Data Parallel C++](https://github.com/oneapi-src/oneAPI-samples/Publications/Data_Parallel_C%2B%2B)\n",
14-
"mdIntro3.5":"* [Tools](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/)\n * [Advisor](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Advisor)\n * [Application Debugger](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/ApplicationDebugger)\n * [Benchmark](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Benchmark)\n * [IoT Connections Tools](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/IoTConnectionsTools)\n * [Migration](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Migration)\n * [Socwatch](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Socwatch)\n * [Trace](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Trace)\n * [UEFI debug](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/UEFI%20debug)\n * [VTune Profiler](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/VTuneProfiler)\n)", "mdIntro4":"To view an alphabetized list of all samples with descriptions by:",
15-
"mdIntro4":"## Additional Resources\n- Samples in [Alphabetical order w/ device target](https://github.com/oneapi-src/CODESAMPLESLIST.md/)\n- Samples by [Change History](https://github.com/oneapi-src/oneAPI-samples/CHANGELOGS.md)",
16-
"mdIntro5":"\n\n## Known Issues or Limitations\n\n### On Windows Platform\n\n",
17-
"mdIntro5.1":"- If you are using Visual Studio 2019, Visual Studio 2019 version 16.4.0 or newer is required.",
18-
"mdIntro5.2":"- Windows support for the FPGA code samples is limited to the FPGA emulator and optimization reports. Compile targets for FPGA hardware are provided on Linux only. See any FPGA code sample for more details.",
19-
"mdIntro5.3":"- If you encounter a compilation error when building a sample program, such as the example error below, the directory path of the sample may be too long. The workaround is to move the sample to a temp directory.",
20-
"mdIntro5.4":" - Example error: *Error MSB6003 The specified task executable dpcpp.exe could not be run .......",
21-
"mdIntro6":"\n\n## Contributing\n\nSee [CONTRIBUTING wiki](https://github.com/oneapi-src/oneAPI-samples/blob/master/CONTRIBUTING.md) for more information.",
22-
"mdIntro7":"\n\n## New Code Samples\n\n|Version Introduced |Sample Name|Description|\n |-----------------------|-------------------------------------------|---------------|\n",
23-
24-
"mdCodeSamplesListIntrop1": "## oneAPI Code Samples\n\nThis Page is a complete list of oneAPI Code Samples, sorted by Alphabetical order",
25-
"mdCodeSamplesListIntrop2": "|Code Sample Name|Supported Intel&reg; Architecture(s)|Description|\n|-----------------------|----------------------|---------------------|\n",
26-
27-
"mdCodeSamplesListFooter": "Report Generated on: ",
28-
29-
"mdVersion": "## Version List of all samples\n\n sorted as found in directories\n\n|Code Sample/URL |Version|\n|-----------------------|------------------------|\n",
30-
31-
"mdChangeLogHeaderp1":"## oneAPI Code Sample Change log\n\nThis document shows the history of when a specific sample was introduced to the oneAPI ecosystem of Code Samples.",
32-
"mdChangeLogHeaderp2":"\n| Version|Code Sample Name|description|\n|-----------------------|------------------|-------------------------|\n"
33-
34-
}
1+
{
2+
"mdLicense": "## License\n\nCode samples are licensed under the MIT license. See [License.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/License.txt) for details.\n\nThird-party program Licenses can be found here: [third-party-programs.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/third-party-programs.txt)",
3+
4+
"mdContribute": "## Contribute\n\nSee [CONTRIBUTING](https://github.com/oneapi-src/oneAPI-samples/blob/master/CONTRIBUTING.md) for more itargetedDevices.ormation.\n\n",
5+
6+
"mdIntro1":"The oneAPI samples repository provides code samples for Intel oneAPI toolkits.<br><br>We recommend checking out a specific stable release version of the repository. The version of the repository you fetch should match the version of the oneAPI compiler you are using. [View available stable releases](https://github.com/oneapi-src/oneAPI-samples/tags). ",
7+
"mdIntro2":"The latest versions (",
8+
"mdIntro2.1":") of code samples on the master branch are not guaranteed to be stable.",
9+
"mdIntro3":"The oneAPI sample repository is organized as follows:",
10+
"mdIntro3.1":"\n\n* [AI-and-Analytics:](https://github.com/oneapi-src/oneAPI-samples/tree/master/AI-and-Analytics)\n * [End-to-End-Workloads](https://github.com/oneapi-src/oneAPI-samples/tree/master/AI-and-Analytics/End-to-end-Workloads)\n * [Features-and-Functionality](https://github.com/oneapi-src/oneAPI-samples/tree/master/AI-and-Analytics/Features-and-Functionality)\n * [Getting-Started-Samples](https://github.com/oneapi-src/oneAPI-samples/tree/master/AI-and-Analytics/Getting-Started-Samples)\n",
11+
"mdIntro3.2":"* [DirectProgramming](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming)\n * [C++](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming/C%2B%2B)\n * [DPC++](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming/DPC%2B%2B)\n * [DPC++FPGA](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming/DPC%2B%2BFPGA)\n * [Reference Designs](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming/DPC%2B%2BFPGA/ReferenceDesigns)\n * [Tutorials](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming/DPC%2B%2BFPGA/Tutorials)\n * [Fortran](https://github.com/oneapi-src/oneAPI-samples/tree/master/DirectProgramming/DPC%2B%2BFPGA)\n",
12+
"mdIntro3.3":"* [Libraries](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries)\n * [oneCCl](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneCCL)\n * [oneDAL](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneDAL)\n * [oneDNN](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneDNN)\n * [oneDPL](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneDPL)\n * [oneMKL](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneMKL)\n * [oneTBB](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneTBB)\n * [oneVPL](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneVPL)\n",
13+
"mdIntro3.4":"* [Publications](https://github.com/oneapi-src/oneAPI-samples/Publications/)\n * [Data Parallel C++](https://github.com/oneapi-src/oneAPI-samples/Publications/Data_Parallel_C%2B%2B)\n",
14+
"mdIntro3.5":"* [Tools](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/)\n * [Advisor](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Advisor)\n * [Application Debugger](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/ApplicationDebugger)\n * [Benchmark](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Benchmark)\n * [IoT Connections Tools](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/IoTConnectionsTools)\n * [Migration](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Migration)\n * [Socwatch](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Socwatch)\n * [Trace](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Trace)\n * [UEFI debug](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/UEFI%20debug)\n * [VTune Profiler](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/VTuneProfiler)\n)",
15+
"mdIntro4":"## Additional Resources\n- Samples in [Alphabetical order w/ device target](https://github.com/oneapi-src/CODESAMPLESLIST.md/)\n- Samples by [Change History](https://github.com/oneapi-src/oneAPI-samples/CHANGELOGS.md)",
16+
"mdIntro5":"\n\n## Known Issues or Limitations\n\n### On Windows Platform\n\n",
17+
"mdIntro5.1":"- If you are using Visual Studio 2019, Visual Studio 2019 version 16.4.0 or newer is required.",
18+
"mdIntro5.2":"- Windows support for the FPGA code samples is limited to the FPGA emulator and optimization reports. Compile targets for FPGA hardware are provided on Linux only. See any FPGA code sample for more details.",
19+
"mdIntro5.3":"- If you encounter a compilation error when building a sample program, such as the example error below, the directory path of the sample may be too long. The workaround is to move the sample to a temp directory.",
20+
"mdIntro5.4":" - Example error: *Error MSB6003 The specified task executable dpcpp.exe could not be run .......",
21+
"mdIntro6":"\n\n## Contributing\n\nSee [CONTRIBUTING wiki](https://github.com/oneapi-src/oneAPI-samples/blob/master/CONTRIBUTING.md) for more information.",
22+
"mdIntro7":"\n\n## New Code Samples\n\n|Version Introduced |Sample Name|Description|\n |-----------------------|-------------------------------------------|---------------|\n",
23+
24+
"mdCodeSamplesListIntrop1": "## oneAPI Code Samples\n\nThis Page is a complete list of oneAPI Code Samples, sorted by Alphabetical order",
25+
"mdCodeSamplesListIntrop2": "|Code Sample Name|Supported Intel&reg; Architecture(s)|Description|\n|-----------------------|----------------------|---------------------|\n",
26+
27+
"mdCodeSamplesListFooter": "Report Generated on: ",
28+
29+
"mdVersion": "## Version List of all samples\n\n sorted as found in directories\n\n|Code Sample/URL |Version|\n|-----------------------|------------------------|\n",
30+
31+
"mdChangeLogHeaderp1":"## oneAPI Code Sample Change log\n\nThis document shows the history of when a specific sample was introduced to the oneAPI ecosystem of Code Samples.",
32+
"mdChangeLogHeaderp2":"\n| Version|Code Sample Name|description|\n|-----------------------|------------------|-------------------------|\n"
33+
}

0 commit comments

Comments
 (0)