Merge branch 'master' into bdmoore1-modin-gstarted-readme-nodemode-update

Author: praveenkk123

.github/ISSUE_TEMPLATE/new_sample.md

@@ -3,7 +3,7 @@ name: Request to add a oneAPI Sample
 about: Use this template to request to add a new Code Sample
 title: 'Request to Add a oneAPI Sample <YourSampleName>'
 labels: 'enhancement'
-assignees: '@JoeOster'
+assignees: Project Manager
 ---
 
 ## Summary

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,8 +1,3 @@
-# Introduction
-This template serves 2 purposes and will need to be edited accordingly prior to submitting the PR
-- Changes to existing samples
-- Submission of new Samples
-
 # Existing Sample Changes
 ## Description
 
@@ -36,15 +31,16 @@ Please describe the tests that you ran to verify your changes. Provide instructi
 **_Delete this line and everything below if this is not a PR for a new code sample_**
 
 **_Delete this line and all above it if this PR is for a new code sample_**
-# Adding a New samples
-##Introduction
+# Adding a New Sample(s)
+
+## Description
 
-The full instructions on submitting a new sample is located in the [wiki](https://github.com/oneapi-src/oneAPI-samples/wiki/Contributing-a-New-Sample) if you have any addional questions contact @JoeOster
+Please include a description of the sample
 
 ## Checklist
 Administrative
 - [ ] Review sample design with the appropriate [Domain Expert](https://github.com/oneapi-src/oneAPI-samples/wiki/Reviewers-and-Domain-Experts): <insert Name Here>
-- [ ] If you dependencies/binaries, inform the oneAPI Code Samples Project Manager: @JoeOster
+- [ ] If you have any new dependencies/binaries, inform the oneAPI Code Samples Project Manager
 
 Code Development
 - [ ] Implement coding guidelines and ensure code quality. [see wiki for details](https://github.com/oneapi-src/oneAPI-samples/wiki/General-Code-Guidelines)
@@ -55,15 +51,12 @@ Code Development
 - [ ] Run jsonlint on sample.json to verify json syntax. www.jsonlint.com
 
 Security and Legal
-- [ ] OSPDT Approval (see @JoeOster for assistance)
+- [ ] OSPDT Approval (see Project Manager for assistance)
 - [ ] Compile using the following compiler flags and fix any warnings, the falgs are: "/Wall -Wformat-security -Werror=format-security"
-- [ ] Protex (see @JoeOster for assistance)
 - [ ] Bandit Scans (Python only)
-- [ ] IPLDT Scan (see @JoeOster for assistance)
 - [ ] Virus scan
 
 Review
 - [ ] Review DPC++ code with Paul Peterseon. (GitHub User: pmpeter1)
-- [ ] Review readme with Tom Lenth(@tomlenth) and/or Joe Oster(@JoeOster)
+- [ ] Review readme with Tom Lenth(@tomlenth) and/or Project Manager
 - [ ] Tested using Dev Cloud when applicable
-

.repo-tools/Docs_Automation/README.md

@@ -0,0 +1,22 @@
+## Description
+
+Adding automation for development of various documents, this will elimate making multiple changes per release cycle, effectively making the process less error prone. Tool currently works on Windows* only.
+
+## Running the tool
+	1. Update your fork to latest from oneapi-src/oneAPI-samples
+	2. Create a branch ex: (New Docs2021.4)to hold the new docs changes
+	3. Switch Branch navigate to the new Branch
+	4. Update guids.json and content.json as appropriate
+	5. From the root of the repo, run .repo-tools/Docs_Automation/create_docs.py
+	6. This will generate the three files in the repo root. CODESMPLESLIST.md, CHNGELOGS.md, README.md
+
+## File List
+|Files |location|Descriptions|
+|---|-|--|
+|content.json|.repo-tools/Doc_Automation|This is a json containing various strings to create the documents. Any doc changes need to be made here|
+|create_docs.py|.repo-tools/Doc_Automation|Tool that creates thefiles listed below. |
+|guids.json|.repo-tools/Doc_Automation|List of guids, names and versions. This file needs to be updated if new samples are added|
+|Generated Files |
+|CODESAMPLESLIST.md| repo root|List of code samples in alphabetical order with targeted device and description of each sample |
+|CHANGELOGS.md| repo root|A running list of all samples sorted by Version(newest) and Alphabetical|
+|README.md| repo root|This is the introductory readme at the root of the repo |

.repo-tools/Docs_Automation/content.json

@@ -0,0 +1,34 @@
+{
+  "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)",
+
+  "mdContribute": "## Contribute\n\nSee [CONTRIBUTING](https://github.com/oneapi-src/oneAPI-samples/blob/master/CONTRIBUTING.md) for more itargetedDevices.ormation.\n\n",
+
+  "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). ",  
+  "mdIntro2":"The latest versions (",
+  "mdIntro2.1":") of code samples on the master branch are not guaranteed to be stable.",
+  "mdIntro3":"The oneAPI sample repository is organized as follows:",
+  "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",
+  "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",
+  "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",
+  "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",
+  "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":"## 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)",
+  "mdIntro5":"\n\n## Known Issues or Limitations\n\n### On Windows Platform\n\n",
+  "mdIntro5.1":"- If you are using Visual Studio 2019, Visual Studio 2019 version 16.4.0 or newer is required.",
+  "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.",
+  "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.",
+  "mdIntro5.4":"    - Example error: *Error MSB6003 The specified task executable dpcpp.exe could not be run .......",
+  "mdIntro6":"\n\n## Contributing\n\nSee [CONTRIBUTING wiki](https://github.com/oneapi-src/oneAPI-samples/blob/master/CONTRIBUTING.md) for more information.",
+  "mdIntro7":"\n\n## New Code Samples\n\n|Version Introduced   |Sample Name|Description|\n |-----------------------|-------------------------------------------|---------------|\n",
+  "mdDeletedSample":"\n\n## Deleted Code Samples\n\n|Version Introduced|Version Deleted|Sample Name|Description|Path|\n |---|---|------|---------------|------|\n",
+  
+  "mdCodeSamplesListIntrop1": "## oneAPI Code Samples\n\nThis Page is a complete list of oneAPI Code Samples, sorted by Alphabetical order",
+  "mdCodeSamplesListIntrop2":  "|Code Sample Name|Supported Intel&reg; Architecture(s)|Description|\n|-----------------------|----------------------|---------------------|\n",
+
+  "mdCodeSamplesListFooter":  "Report Generated on:  ",
+  
+  "mdVersion": "## Version List of all samples\n\n sorted as found in directories\n\n|Code Sample/URL |Version|\n|-----------------------|------------------------|\n",
+
+  "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.",
+  "mdChangeLogHeaderp2":"\n| Version|Code Sample Name|description|\n|-----------------------|------------------|-------------------------|\n"
+}